Enum bevy_internal::ui::measurement::AvailableSpace

pub enum AvailableSpace {
    Definite(f32),
    MinContent,
    MaxContent,
}

The amount of space available to a node in a given axis https://www.w3.org/TR/css-sizing-3/#available

Variants

Definite(f32)

The amount of space available is the specified number of pixels

MinContent

The amount of space available is indefinite and the node should be laid out under a min-content constraint

MaxContent

The amount of space available is indefinite and the node should be laid out under a max-content constraint

Implementations

impl AvailableSpace

pub fn is_definite(self) -> bool

Returns true for definite values, else false

pub fn into_option(self) -> Option<f32>

Convert to Option Definite values become Some(value). Contraints become None.

pub fn unwrap_or(self, default: f32) -> f32

Return the definite value or a default value

pub fn unwrap(self) -> f32

Return the definite value. Panic is the value is not definite.

pub fn or(self, default: AvailableSpace) -> AvailableSpace

Return self if definite or a default value

pub fn or_else( self, default_cb: impl FnOnce() -> AvailableSpace ) -> AvailableSpace

Return self if definite or a the result of the default value callback

pub fn unwrap_or_else(self, default_cb: impl FnOnce() -> f32) -> f32

Return the definite value or the result of the default value callback

pub fn maybe_set(self, value: Option<f32>) -> AvailableSpace

If passed value is Some then return AvailableSpace::Definite containing that value, else return self

pub fn map_definite_value( self, map_function: impl FnOnce(f32) -> f32 ) -> AvailableSpace

If passed value is Some then return AvailableSpace::Definite containing that value, else return self

pub fn compute_free_space(&self, used_space: f32) -> f32

Compute free_space given the passed used_space

pub fn is_roughly_equal(self, other: AvailableSpace) -> bool

Compare equality with another AvailableSpace, treating definite values that are within f32::EPSILON of each other as equal

Trait Implementations

impl Clone for AvailableSpace

fn clone(&self) -> AvailableSpace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AvailableSpace

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

Formats the value using the given formatter.

impl From<Option<f32>> for AvailableSpace

fn from(option: Option<f32>) -> AvailableSpace

Converts to this type from the input type.

impl From<f32> for AvailableSpace

fn from(value: f32) -> AvailableSpace

Converts to this type from the input type.

impl FromPoints for AvailableSpace

fn from_points<Input>(points: Input) -> AvailableSpace

where Input: Into<f32> + Copy,

Converts into an Into<f32> into Self

impl PartialEq for AvailableSpace

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TaffyMaxContent for AvailableSpace

const MAX_CONTENT: AvailableSpace = Self::MaxContent

The max_content value for type implementing TaffyZero

impl TaffyMinContent for AvailableSpace

const MIN_CONTENT: AvailableSpace = Self::MinContent

The min_content value for type implementing TaffyZero

impl TaffyZero for AvailableSpace

const ZERO: AvailableSpace = _

The zero value for type implementing TaffyZero

impl Copy for AvailableSpace

impl StructuralPartialEq for AvailableSpace