Struct zng_layout::unit::PxConstraints2d

source ·
pub struct PxConstraints2d {
    pub x: PxConstraints,
    pub y: PxConstraints,
}
Expand description

Pixel size constraints.

These constraints can express lower and upper bounds, unbounded upper and preference of fill length for both the x and y axis.

Fields§

§x: PxConstraints

Constraints of lengths in the x or width dimension.

§y: PxConstraints

Constraints of lengths in the y or height dimension.

Implementations§

source§

impl PxConstraints2d

source

pub fn new_unbounded() -> Self

New unbounded constrain.

source

pub fn new_bounded(max_x: Px, max_y: Px) -> Self

New bounded between zero and max_y, max_y with no fill.

source

pub fn new_bounded_size(max: PxSize) -> Self

New bounded between zero and max with no fill.

source

pub fn new_exact(x: Px, y: Px) -> Self

New bounded to only allow the size and fill.

The type PxSize can also be converted into fixed constraints.

source

pub fn new_exact_size(size: PxSize) -> Self

New bounded to only allow the size and fill.

source

pub fn new_fill(x: Px, y: Px) -> Self

New bounded to fill the maximum x and y.

source

pub fn new_fill_size(size: PxSize) -> Self

New bounded to fill the maximum size.

source

pub fn new_range(min_x: Px, max_x: Px, min_y: Px, max_y: Px) -> Self

New bounded to a inclusive range.

A tuple of two PxSize values can also be converted to these constraints.

§Panics

Panics if min is greater then max.

source

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

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

source

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

Returns a copy of the current constraints that has min_x and min_y as the lower bound and max adjusted to be >= min in both axis, if the new min is greater then the current min.

source

pub fn with_new_min_size(self, min: PxSize) -> Self

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

source

pub fn with_min_size(self, min: PxSize) -> Self

Returns a copy of the current constraints that has min as the lower bound and max adjusted to be >= min in both axis, if the new min is greater then the current min.

source

pub fn with_new_min_x(self, min_x: Px) -> Self

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

source

pub fn with_new_min_y(self, min_y: Px) -> Self

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

source

pub fn with_min_x(self, min_x: Px) -> Self

Returns a copy of the current constraints that has min_x as the lower bound and max adjusted to be >= min in the x axis if the new min is greater then the current min.

source

pub fn with_min_y(self, min_y: Px) -> Self

Returns a copy of the current constraints that has min_y as the lower bound and max adjusted to be >= min in the y axis if the new min is greater then the current min.

source

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

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

source

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

Returns a copy of the current constraints that has max_x and max_y as the upper bound and min adjusted to be <= max in both axis if the new max if less then the current max.

source

pub fn with_new_max_size(self, max: PxSize) -> Self

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

source

pub fn with_max_size(self, max: PxSize) -> Self

Returns a copy of the current constraints that has max as the upper bound and min adjusted to be <= max in both axis if the new max if less then the current max.

source

pub fn with_new_max_x(self, max_x: Px) -> Self

Returns a copy of the current constraints that has min_x as the lower bound and max adjusted to be << max in the x axis.

source

pub fn with_new_max_y(self, max_y: Px) -> Self

Returns a copy of the current constraints that has max_y as the lower bound and min adjusted to be <= max in the y axis.

source

pub fn with_max_x(self, max_x: Px) -> Self

Returns a copy of the current constraints that has min_x as the lower bound and max adjusted to be << max in the x axis if the new max if less then the current max.

source

pub fn with_max_y(self, max_y: Px) -> Self

Returns a copy of the current constraints that has max_y as the lower bound and min adjusted to be <= max in the y axis if the new max if less then the current max.

source

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

Returns a copy with min and max bounds set to x and y.

source

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

Returns a copy with min and max bounds set to x and y clamped by the current constraints.

source

pub fn with_new_exact_size(self, size: PxSize) -> Self

Returns a copy with min and max bounds set to size.

source

pub fn with_exact_size(self, size: PxSize) -> Self

Returns a copy with min and max bounds set to size clamped by the current constraints.

source

pub fn with_new_exact_x(self, x: Px) -> Self

Returns a copy of the current constraints with the x maximum and minimum set to x.

source

pub fn with_new_exact_y(self, y: Px) -> Self

Returns a copy of the current constraints with the y maximum and minimum set to y.

source

pub fn with_exact_x(self, x: Px) -> Self

Returns a copy of the current constraints with the x maximum and minimum set to x clamped by the current constraints.

source

pub fn with_exact_y(self, y: Px) -> Self

Returns a copy of the current constraints with the y maximum and minimum set to y clamped by the current constraints.

source

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

Returns a copy of the current constraints that sets the fill_x and fill_y preference.

source

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

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

source

pub fn with_fill_vector(self, fill: BoolVector2D) -> Self

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

source

pub fn with_fill_x(self, fill_x: bool) -> Self

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

source

pub fn with_fill_y(self, fill_y: bool) -> Self

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

source

pub fn with_unbounded(self) -> Self

Returns a copy of the current constraints without upper bound in both axis.

source

pub fn with_unbounded_x(self) -> Self

Returns a copy of the current constraints without a upper bound in the x axis.

source

pub fn with_unbounded_y(self) -> Self

Returns a copy of the current constraints without a upper bound in the y axis.

source

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

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

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

source

pub fn with_less_size(self, sub: PxSize) -> 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_less_x(self, sub_x: Px) -> Self

Returns a copy of the current constraints with sub_x subtracted from the min and max bounds of the x axis.

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

source

pub fn with_less_y(self, sub_y: Px) -> Self

Returns a copy of the current constraints with sub_y subtracted from the min and max bounds of the y axis.

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

source

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

Returns a copy of the current constraints with add_x and add_y added to the maximum bounds.

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

source

pub fn with_more_size(self, add: PxSize) -> 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 with_x(self, x: impl FnOnce(PxConstraints) -> PxConstraints) -> Self

Returns a copy of the current constraints with x modified by the closure.

source

pub fn with_y(self, y: impl FnOnce(PxConstraints) -> PxConstraints) -> Self

Returns a copy of the current constraints with y modified by the closure.

source

pub fn is_bounded(self) -> BoolVector2D

Gets if the constraints have an upper bound.

source

pub fn is_unbounded(self) -> BoolVector2D

Gets if the constraints have no upper bound.

source

pub fn is_exact(self) -> BoolVector2D

Gets if the constraints only allow one length.

source

pub fn is_fill_pref(self) -> BoolVector2D

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) -> BoolVector2D

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

source

pub fn fixed_size(self) -> Option<PxSize>

Gets the fixed size if the constraints only allow one length in both axis.

source

pub fn max_size(self) -> Option<PxSize>

Gets the maximum allowed size, or None if is unbounded in any of the axis.

The maximum is inclusive.

source

pub fn min_size(self) -> PxSize

Gets the minimum allowed size. The minimum is inclusive.

source

pub fn clamp_size(self, size: PxSize) -> PxSize

Clamp the size by min and max.

source

pub fn fill_size(self) -> PxSize

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

source

pub fn fill_size_or(self, size: PxSize) -> PxSize

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

source

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

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

source

pub fn max_size_or(self, size: PxSize) -> PxSize

Gets the maximum size if bounded, or the size clamped by constraints.

source

pub fn max_bounded_size(self) -> PxSize

Gets the maximum size if bounded, or the minimum if not.

source

pub fn fill_ratio(self, size: PxSize) -> PxSize

Gets the maximum fill size that preserves the size ratio.

Trait Implementations§

source§

impl Clone for PxConstraints2d

source§

fn clone(&self) -> PxConstraints2d

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 PxConstraints2d

source§

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

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

impl Default for PxConstraints2d

source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for PxConstraints2d

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<(Size2D<Px, Px>, Size2D<Px, Px>)> for PxConstraints2d

source§

fn from((a, b): (PxSize, PxSize)) -> Self

New range, the minimum and maximum is computed.

source§

impl From<Size2D<Px, Px>> for PxConstraints2d

source§

fn from(size: PxSize) -> Self

New exact.

source§

impl Hash for PxConstraints2d

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<PxConstraints2d> for (PxSize, PxSize)

source§

fn into_var(self) -> Self::Var

New range, the minimum and maximum is computed.

source§

type Var = LocalVar<PxConstraints2d>

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 IntoVar<PxConstraints2d> for PxSize

source§

fn into_var(self) -> Self::Var

New exact.

source§

type Var = LocalVar<PxConstraints2d>

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 PxConstraints2d

source§

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

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 PxConstraints2d

source§

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

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

impl Copy for PxConstraints2d

source§

impl Eq for PxConstraints2d

source§

impl IntoValue<PxConstraints2d> for (PxSize, PxSize)

source§

impl IntoValue<PxConstraints2d> for PxSize

source§

impl StructuralPartialEq for PxConstraints2d

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,