Struct Strength 

pub struct Strength(/* private fields */);

Implementations

impl Strength

pub const REQUIRED: Strength

The required strength for a constraint. This is the strongest possible strength.

pub const STRONG: Strength

A strong strength for a constraint. This is weaker than REQUIRED but stronger than MEDIUM.

pub const MEDIUM: Strength

A medium strength for a constraint. This is weaker than STRONG but stronger than WEAK.

pub const WEAK: Strength

A weak strength for a constraint. This is weaker than MEDIUM but stronger than 0.0.

pub const ZERO: Strength

The weakest possible strength for a constraint. This is weaker than WEAK.

pub const fn new(value: f64) -> Self

Create a new strength with the given value, clipped to the legal range (0.0, REQUIRED)

pub const fn create( strong: f64, medium: f64, weak: f64, multiplier: f64, ) -> Self

Create a constraint as a linear combination of STRONG, MEDIUM and WEAK strengths.

Each weight is multiplied by the multiplier, clamped to the legal range and then multiplied by the corresponding strength. The resulting strengths are then summed.

pub const fn value(&self) -> f64

The value of the strength

pub const fn add(self, rhs: Self) -> Self

Add two strengths together, clamping the result to the legal range

pub const fn sub(self, rhs: Self) -> Self

Subtract one strength from another, clipping the result to the legal range

pub const fn mul_f64(self, rhs: f64) -> Self

Multiply a strength by a scalar, clipping the result to the legal range

pub const fn mul_f32(self, rhs: f32) -> Self

Multiply a strength by a scalar, clipping the result to the legal range

pub const fn div_f64(self, rhs: f64) -> Self

Divide a strength by a scalar, clipping the result to the legal range

pub const fn div_f32(self, rhs: f32) -> Self

Divide a strength by a scalar, clipping the result to the legal range

Trait Implementations

impl Add for Strength

fn add(self, rhs: Self) -> Self

Add two strengths together, clipping the result to the legal range

type Output = Strength

The resulting type after applying the + operator.

impl AddAssign for Strength

fn add_assign(&mut self, rhs: Self)

Perform an in-place addition of two strengths, clipping the result to the legal range

impl Clone for Strength

fn clone(&self) -> Strength

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strength

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

Formats the value using the given formatter.

impl Mul<Strength> for f64

fn mul(self, rhs: Strength) -> Strength

Multiply a scalar by a strength, clipping the result to the legal range

type Output = Strength

The resulting type after applying the * operator.

impl Mul<f64> for Strength

fn mul(self, rhs: f64) -> Strength

Multiply a strength by a scalar, clipping the result to the legal range

type Output = Strength

The resulting type after applying the * operator.

impl MulAssign<f64> for Strength

fn mul_assign(&mut self, rhs: f64)

Perform an in-place multiplication of a strength by a scalar, clipping the result to the legal range

impl Ord for Strength

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Strength

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Strength

fn sub(self, rhs: Strength) -> Strength

Subtract one strength from another, clipping the result to the legal range

type Output = Strength

The resulting type after applying the - operator.

impl SubAssign for Strength

fn sub_assign(&mut self, rhs: Self)

Perform an in-place subtraction of two strengths, clipping the result to the legal range

impl Copy for Strength

impl Eq for Strength

impl StructuralPartialEq for Strength