Struct zng::layout::PxConstraints

pub struct PxConstraints {
    pub fill: bool,
    /* private fields */
}

Pixel length constraints.

These constraints can express lower and upper bounds, unbounded upper and preference of fill length.

See also the PxConstraints2d.

Fields

fill: bool

Fill preference, when this is true and the constraints have a maximum bound the fill length is the maximum bounds, otherwise the fill length is the minimum bounds.

Implementations

impl PxConstraints

pub fn new_unbounded() -> PxConstraints

New unbounded constrain.

pub fn new_bounded(max: Px) -> PxConstraints

New bounded between zero and max with no fill.

pub fn new_exact(length: Px) -> PxConstraints

New bounded to only allow the length and fill.

pub fn new_fill(length: Px) -> PxConstraints

New bounded to fill the length.

pub fn new_range(min: Px, max: Px) -> PxConstraints

New bounded to a inclusive range.

Panics

Panics if min is not <= max.

pub fn with_new_min(self, min: Px) -> PxConstraints

Returns a copy of the current constraints that has min as the lower bound and max adjusted to be >= min.

pub fn with_min(self, min: Px) -> PxConstraints

Returns a copy with_new_min if min is greater then the current minimum.

pub fn with_new_max(self, max: Px) -> PxConstraints

Returns a copy of the current constraints that has max as the upper bound and min adjusted to be <= max.

pub fn with_max(self, max: Px) -> PxConstraints

Returns a copy with_new_max if max is less then the current maximum or the current maximum is unbounded.

pub fn with_new_exact(self, len: Px) -> PxConstraints

Returns a copy of the current constraints that has max and min set to len and fill enabled.

pub fn with_exact(self, len: Px) -> PxConstraints

Returns a copy with_new_exact if the new length clamped by the current constraints.

pub fn with_fill(self, fill: bool) -> PxConstraints

Returns a copy of the current constraints that sets the fill preference.

pub fn with_fill_and(self, fill: bool) -> PxConstraints

Returns a copy of the current constraints that sets the fill preference to self.fill && fill.

pub fn with_unbounded(self) -> PxConstraints

Returns a copy of the current constraints without upper bound.

pub fn with_less(self, sub: Px) -> PxConstraints

Returns a copy of the current constraints with sub subtracted from the min and max bounds.

The subtraction is saturating, does not subtract max if unbounded.

pub fn with_more(self, add: Px) -> PxConstraints

Returns a copy of the current constraints with add added to the maximum bounds.

Does a saturation addition, this can potentially unbound the constraints if Px::MAX is reached.

pub fn is_bounded(self) -> bool

Gets if the constraints have an upper bound.

pub fn is_unbounded(self) -> bool

Gets if the constraints have no upper bound.

pub fn is_exact(self) -> bool

Gets if the constraints only allow one length.

pub fn is_fill_pref(self) -> bool

Gets if the context prefers the maximum length over the minimum.

Note that if the constraints are unbounded there is not maximum length, in this case the fill length is the minimum.

pub fn is_fill_max(self) -> bool

Gets if the context prefers the maximum length and there is a maximum length.

pub fn exact(self) -> Option<Px>

Gets the fixed length if the constraints only allow one length.

pub fn max(self) -> Option<Px>

Gets the maximum allowed length, or None if is unbounded.

The maximum is inclusive.

pub fn min(self) -> Px

Gets the minimum allowed length. The minimum is inclusive.

pub fn max_bounded(self) -> Px

Gets the maximum length if it is bounded, or the minimum if not.

pub fn clamp(self, px: Px) -> Px

Clamp the px by min and max.

pub fn fill(self) -> Px

Gets the fill length, if fill is true this is the maximum length, otherwise it is the minimum length.

pub fn fill_or(self, length: Px) -> Px

Gets the maximum if fill is preferred and max is bounded, or length clamped by the constraints.

pub fn fill_or_exact(self) -> Option<Px>

Gets the max size if is fill and has max bounds, or gets the exact size if min equals max.

pub fn max_or(self, length: Px) -> Px

Gets the maximum length if bounded or length clamped by the constraints.

Trait Implementations

impl Clone for PxConstraints

fn clone(&self) -> PxConstraints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PxConstraints

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

Formats the value using the given formatter.

impl Default for PxConstraints

fn default() -> PxConstraints

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PxConstraints

fn deserialize<__D>( __deserializer: __D, ) -> Result<PxConstraints, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Px> for PxConstraints

fn from(length: Px) -> PxConstraints

New exact.

impl Hash for PxConstraints

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 IntoVar<PxConstraints> for Px

fn into_var(self) -> <Px as IntoVar<PxConstraints>>::Var

New exact.

type Var = LocalVar<PxConstraints>

Variable type that will wrap the T value.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for PxConstraints

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transitionable for PxConstraints

fn lerp(self, to: &PxConstraints, step: Factor) -> PxConstraints

Sample the linear interpolation from self -> to by step.

impl Copy for PxConstraints

impl Eq for PxConstraints

impl IntoValue<PxConstraints> for Px

impl StructuralPartialEq for PxConstraints