Struct LayerIndex

pub struct LayerIndex(pub u32);

Represents a layer in a window.

See LAYERS for more information.

Tuple Fields

0: u32

Implementations

impl LayerIndex

pub const TOP_MOST: LayerIndex = _

The top-most layer.

Only widgets that are pretending to be a child window should use this layer, including menus, drop-downs, pop-ups and tooltips.

This is the u32::MAX value.

pub const ADORNER: LayerIndex = _

The layer for adorner display items.

Adorner widgets are related to another widget but not as a visual part of it, examples of adorners are resize handles in a widget visual editor, or an interactive help/guide feature.

This is the TOP_MOST - u16::MAX value.

pub const DEFAULT: LayerIndex = _

The default layer, just above the normal window content.

This is the 0 value.

pub fn saturating_add(self, other: impl Into<LayerIndex>) -> Self

Compute self + other saturating at the TOP_MOST bound instead of overflowing.

pub fn saturating_sub(self, other: impl Into<LayerIndex>) -> Self

Compute self - other saturating at the DEFAULT bound instead of overflowing.

pub fn name(self) -> Option<&'static str>

Gets the const name of this value.

Trait Implementations

impl<T: Into<Self>> Add<T> for LayerIndex

Calls LayerIndex::saturating_add.

type Output = LayerIndex

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: Into<Self>> AddAssign<T> for LayerIndex

Calls LayerIndex::saturating_add.

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for LayerIndex

fn clone(&self) -> LayerIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayerIndex

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

Formats the value using the given formatter.

impl Default for LayerIndex

fn default() -> LayerIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LayerIndex

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<Factor> for LayerIndex

type Output = LayerIndex

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Self::Output

Performs the / operation.

impl DivAssign<Factor> for LayerIndex

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl From<u32> for LayerIndex

fn from(index: u32) -> Self

Converts to this type from the input type.

impl FromStr for LayerIndex

type Err = <u32 as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoVar<LayerIndex> for u32

type Var = LocalVar<LayerIndex>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Mul<Factor> for LayerIndex

type Output = LayerIndex

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Self::Output

Performs the * operation.

impl MulAssign<Factor> for LayerIndex

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl Ord for LayerIndex

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

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

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Into<Self>> Sub<T> for LayerIndex

Calls LayerIndex::saturating_sub.

type Output = LayerIndex

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: Into<Self>> SubAssign<T> for LayerIndex

Calls LayerIndex::saturating_sub.

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl Copy for LayerIndex

impl Eq for LayerIndex

impl IntoValue<LayerIndex> for u32

impl StructuralPartialEq for LayerIndex