Enum Reason

#[non_exhaustive]
#[repr(u32)]
pub enum Reason {
    Launch = 1,
    Recover = 2,
    SessionRestore = 3,
}

Available on crate feature client only.

reason for getting a session

The reason may determine in what way a session restores the window management state of associated toplevels.

For example newly launched applications might be launched on the active workspace with restored size and position, while a recovered applications might restore additional state such as active workspace and stacking order.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Launch = 1

an app is newly launched

A new app instance is launched, for example from an app launcher.

Recover = 2

an app recovered

A app instance is recovering from for example a compositor or app crash.

SessionRestore = 3

an app restored

A app instance is restored, for example part of a restored session, or restored from having been temporarily terminated due to resource constraints.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl From<Reason> for u32

fn from(val: Reason) -> u32

Converts to this type from the input type.

impl Hash for Reason

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 Reason

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

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

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Reason

impl Eq for Reason

impl StructuralPartialEq for Reason