Struct WindowState

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

Available on crate feature wayland and Linux only.

The configured state of the window.

Implementations

impl WindowState

pub const MAXIMIZED: WindowState

The surface is maximized. The window geometry specified in the configure event must be obeyed by the client. The client should draw without shadow or other decoration outside of the window geometry.

pub const FULLSCREEN: WindowState

The surface is fullscreen. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. For a surface to cover the whole fullscreened area, the geometry dimensions must be obeyed by the client. For more details, see xdg_toplevel.set_fullscreen.

pub const RESIZING: WindowState

The surface is being resized. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. Clients that have aspect ratio or cell sizing configuration can use a smaller size, however.

pub const ACTIVATED: WindowState

Client window decorations should be painted as if the window is active. Do not assume this means that the window actually has keyboard or pointer focus.

pub const TILED_LEFT: WindowState

The window is currently in a tiled layout and the left edge is considered to be adjacent to another part of the tiling grid.

pub const TILED_RIGHT: WindowState

The window is currently in a tiled layout and the right edge is considered to be adjacent to another part of the tiling grid.

pub const TILED_TOP: WindowState

The window is currently in a tiled layout and the top edge is considered to be adjacent to another part of the tiling grid.

pub const TILED_BOTTOM: WindowState

The window is currently in a tiled layout and the bottom edge is considered to be adjacent to another part of the tiling grid.

pub const TILED: WindowState

An alias for all tiled bits set.

pub const SUSPENDED: WindowState

The surface is currently not ordinarily being repainted; for example because its content is occluded by another window, or its outputs are switched off due to screen locking.

impl WindowState

pub const fn empty() -> WindowState

Get a flags value with all bits unset.

pub const fn all() -> WindowState

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

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

pub const fn from_bits(bits: u16) -> Option<WindowState>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u16) -> WindowState

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> WindowState

Convert from a bits value exactly.

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

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: WindowState) -> bool

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

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

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

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

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

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

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: WindowState)

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

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

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

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

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

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

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

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

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: WindowState) -> WindowState

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

pub const fn complement(self) -> WindowState

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

impl WindowState

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

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<WindowState>

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 WindowState

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

Formats the value using the given formatter.

impl BitAnd for WindowState

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

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

type Output = WindowState

The resulting type after applying the & operator.

impl BitAndAssign for WindowState

fn bitand_assign(&mut self, other: WindowState)

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

impl BitOr for WindowState

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

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

type Output = WindowState

The resulting type after applying the | operator.

impl BitOrAssign for WindowState

fn bitor_assign(&mut self, other: WindowState)

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

impl BitXor for WindowState

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

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

type Output = WindowState

The resulting type after applying the ^ operator.

impl BitXorAssign for WindowState

fn bitxor_assign(&mut self, other: WindowState)

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

impl Clone for WindowState

fn clone(&self) -> WindowState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowState

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

Formats the value using the given formatter.

impl Extend<WindowState> for WindowState

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

where T: IntoIterator<Item = WindowState>,

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 WindowState

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

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> WindowState

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<WindowState> for WindowState

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

where T: IntoIterator<Item = WindowState>,

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

impl Hash for WindowState

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 WindowState

type Item = WindowState

The type of the elements being iterated over.

type IntoIter = Iter<WindowState>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for WindowState

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

Formats the value using the given formatter.

impl Not for WindowState

fn not(self) -> WindowState

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

type Output = WindowState

The resulting type after applying the ! operator.

impl Octal for WindowState

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

Formats the value using the given formatter.

impl PartialEq for WindowState

fn eq(&self, other: &WindowState) -> 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 WindowState

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

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 = WindowState

The resulting type after applying the - operator.

impl SubAssign for WindowState

fn sub_assign(&mut self, other: WindowState)

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 UpperHex for WindowState

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

Formats the value using the given formatter.

impl Copy for WindowState

impl Eq for WindowState

impl StructuralPartialEq for WindowState