Struct PxConstraints2d

pub struct PxConstraints2d {
    pub x: PxConstraints,
    pub y: PxConstraints,
}

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

impl PxConstraints2d

pub fn new_unbounded() -> Self

New unbounded constrain.

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

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

pub fn new_bounded_size(max: PxSize) -> Self

New bounded between zero and max with no fill.

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.

pub fn new_exact_size(size: PxSize) -> Self

New bounded to only allow the size and fill.

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

New bounded to fill the maximum x and y.

pub fn new_fill_size(size: PxSize) -> Self

New bounded to fill the maximum size.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

pub fn with_unbounded(self) -> Self

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

pub fn with_unbounded_x(self) -> Self

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

pub fn with_unbounded_y(self) -> Self

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

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.

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.

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.

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.

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.

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.

pub fn with_x(self, x: impl FnOnce(PxConstraints) -> PxConstraints) -> Self

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

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

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

pub fn is_bounded(self) -> BoolVector2D

Gets if the constraints have an upper bound.

pub fn is_unbounded(self) -> BoolVector2D

Gets if the constraints have no upper bound.

pub fn is_exact(self) -> BoolVector2D

Gets if the constraints only allow one length.

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.

pub fn is_fill_max(self) -> BoolVector2D

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

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

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

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.

pub fn min_size(self) -> PxSize

Gets the minimum allowed size. The minimum is inclusive.

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

Clamp the size by min and max.

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.

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.

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.

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

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

pub fn max_bounded_size(self) -> PxSize

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

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

Gets the maximum fill size that preserves the size ratio.

Trait Implementations

impl Clone for PxConstraints2d

fn clone(&self) -> PxConstraints2d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PxConstraints2d

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

Formats the value using the given formatter.

impl Default for PxConstraints2d

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

New range, the minimum and maximum is computed.

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

fn from(size: PxSize) -> Self

New exact.

impl Hash for PxConstraints2d

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

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

fn into_var(self) -> Self::Var

New range, the minimum and maximum is computed.

type Var = LocalVar<PxConstraints2d>

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

fn into_var(self) -> Self::Var

New exact.

type Var = LocalVar<PxConstraints2d>

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 PxConstraints2d

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transitionable for PxConstraints2d

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

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

impl Copy for PxConstraints2d

impl Eq for PxConstraints2d

impl IntoValue<PxConstraints2d> for (PxSize, PxSize)

impl IntoValue<PxConstraints2d> for PxSize

impl StructuralPartialEq for PxConstraints2d