Struct State 

#[non_exhaustive]
pub struct State(pub u32);

types of state on the surface

The different state values used on the surface. This is designed for state values like maximized, fullscreen. It is paired with the configure event to ensure that both the client and the compositor setting the state can be synchronized.

States set in this way are double-buffered, see wl_surface.commit.

Tuple Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

0: u32

Implementations

impl State

pub const Maximized: Self

the surface is maximized

The surface is maximized. The window geometry specified in the configure event must be obeyed by the client, or the xdg_wm_base.invalid_surface_state error is raised.

The client should draw without shadow or other decoration outside of the window geometry.

pub const Fullscreen: Self

the surface is fullscreen

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: Self

the surface is being resized

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: Self

the surface is now activated

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 TiledLeft: Self

the surface’s left edge is tiled

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

The client should draw without shadow or other decoration outside of the window geometry on the left edge.

pub const TiledRight: Self

the surface’s right edge is tiled

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

The client should draw without shadow or other decoration outside of the window geometry on the right edge.

pub const TiledTop: Self

the surface’s top edge is tiled

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

The client should draw without shadow or other decoration outside of the window geometry on the top edge.

pub const TiledBottom: Self

the surface’s bottom edge is tiled

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

The client should draw without shadow or other decoration outside of the window geometry on the bottom edge.

pub const Suspended: Self

surface repaint is suspended

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.

pub const ConstrainedLeft: Self

the surface’s left edge is constrained

The left edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

pub const ConstrainedRight: Self

the surface’s right edge is constrained

The right edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

pub const ConstrainedTop: Self

the surface’s top edge is constrained

The top edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

pub const ConstrainedBottom: Self

the surface’s bottom edge is constrained

The bottom edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl From<State> for u32

fn from(val: State) -> u32

Converts to this type from the input type.

impl Hash for State

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

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 Ord for State

fn cmp(&self, other: &State) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for State

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

fn partial_cmp(&self, other: &State) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u32> for State

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for State

impl Eq for State

impl StructuralPartialEq for State