Struct Mode

pub struct Mode(/* private fields */);

Available on crate feature wayland and Linux only.

mode information

These flags describe properties of an output mode. They are used in the flags bitfield of the mode event.

Implementations

impl Mode

pub const Current: Mode

indicates this is the current mode

pub const Preferred: Mode

indicates this is the preferred mode

impl Mode

pub const fn empty() -> Mode

Get a flags value with all bits unset.

pub const fn all() -> Mode

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Mode>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Mode

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Mode

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Mode>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Mode) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: Mode) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: Mode)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: Mode)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Mode)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: Mode, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Mode) -> Mode

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: Mode) -> Mode

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: Mode) -> Mode

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Mode) -> Mode

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> Mode

The bitwise negation (!) of the bits in self, truncating the result.

impl Mode

pub const fn iter(&self) -> Iter<Mode>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Mode>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for Mode

fn bitand(self, other: Mode) -> Mode

The bitwise and (&) of the bits in self and other.

type Output = Mode

The resulting type after applying the & operator.

impl BitAndAssign for Mode

fn bitand_assign(&mut self, other: Mode)

The bitwise and (&) of the bits in self and other.

impl BitOr for Mode

fn bitor(self, other: Mode) -> Mode

The bitwise or (|) of the bits in self and other.

type Output = Mode

The resulting type after applying the | operator.

impl BitOrAssign for Mode

fn bitor_assign(&mut self, other: Mode)

The bitwise or (|) of the bits in self and other.

impl BitXor for Mode

fn bitxor(self, other: Mode) -> Mode

The bitwise exclusive-or (^) of the bits in self and other.

type Output = Mode

The resulting type after applying the ^ operator.

impl BitXorAssign for Mode

fn bitxor_assign(&mut self, other: Mode)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Extend<Mode> for Mode

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = Mode>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Mode

const FLAGS: &'static [Flag<Mode>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> Mode

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<Mode> for Mode

fn from_iter<T>(iterator: T) -> Mode

where T: IntoIterator<Item = Mode>,

The bitwise or (|) of the bits in each flags value.

impl Hash for Mode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Mode

type Item = Mode

The type of the elements being iterated over.

type IntoIter = Iter<Mode>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Mode as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for Mode

fn not(self) -> Mode

The bitwise negation (!) of the bits in self, truncating the result.

type Output = Mode

The resulting type after applying the ! operator.

impl Octal for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for Mode

fn eq(&self, other: &Mode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Mode

fn sub(self, other: Mode) -> Mode

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Mode

The resulting type after applying the - operator.

impl SubAssign for Mode

fn sub_assign(&mut self, other: Mode)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TryFrom<u32> for Mode

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<Mode, ()>

Performs the conversion.

impl UpperHex for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode