Struct zng_layout::unit::PxConstraints

source ·
pub struct PxConstraints {
    pub fill: bool,
    /* private fields */
}
Expand description

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§

source§

impl PxConstraints

source

pub fn new_unbounded() -> Self

New unbounded constrain.

source

pub fn new_bounded(max: Px) -> Self

New bounded between zero and max with no fill.

source

pub fn new_exact(length: Px) -> Self

New bounded to only allow the length and fill.

source

pub fn new_fill(length: Px) -> Self

New bounded to fill the length.

source

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

New bounded to a inclusive range.

§Panics

Panics if min is not <= max.

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

pub fn with_unbounded(self) -> Self

Returns a copy of the current constraints without upper bound.

source

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

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.

source

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

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.

source

pub fn is_bounded(self) -> bool

Gets if the constraints have an upper bound.

source

pub fn is_unbounded(self) -> bool

Gets if the constraints have no upper bound.

source

pub fn is_exact(self) -> bool

Gets if the constraints only allow one length.

source

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.

source

pub fn is_fill_max(self) -> bool

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

source

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

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

source

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

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

The maximum is inclusive.

source

pub fn min(self) -> Px

Gets the minimum allowed length. The minimum is inclusive.

source

pub fn max_bounded(self) -> Px

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

source

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

Clamp the px by min and max.

source

pub fn fill(self) -> Px

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

source

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.

source

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.

source

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

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

Trait Implementations§

source§

impl Clone for PxConstraints

source§

fn clone(&self) -> PxConstraints

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PxConstraints

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for PxConstraints

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Px> for PxConstraints

source§

fn from(length: Px) -> Self

New exact.

source§

impl Hash for PxConstraints

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl IntoVar<PxConstraints> for Px

source§

fn into_var(self) -> Self::Var

New exact.

source§

type Var = LocalVar<PxConstraints>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl PartialEq for PxConstraints

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for PxConstraints

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Transitionable for PxConstraints

source§

fn lerp(self, to: &Self, step: EasingStep) -> Self

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

impl Copy for PxConstraints

source§

impl Eq for PxConstraints

source§

impl IntoValue<PxConstraints> for Px

source§

impl StructuralPartialEq for PxConstraints

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyVarValue for T
where T: VarValue,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.
source§

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.
source§

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.
source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.
source§

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoVar<T> for T
where T: VarValue,

source§

type Var = LocalVar<T>

Variable type that will wrap the T value. Read more
source§

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

Converts the source value into a var.
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> IntoValue<T> for T
where T: VarValue,

source§

impl<T> VarValue for T
where T: Debug + Clone + PartialEq + Any + Send + Sync,