Struct bismuth::clamp::Clamped

pub struct Clamped<T, R>(_, _)
 where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>;

Methods

impl<T, R> Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

pub fn new(value: T) -> Self

pub fn max_value() -> Self

pub fn max_inner_value() -> T

pub fn min_value() -> Self

pub fn min_inner_value() -> T

pub fn to_inner(&self) -> T

Trait Implementations

impl<T: Clone, R: Clone> Clone for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

fn clone(&self) -> Clamped<T, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, R: Copy> Copy for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

impl<T, R> Clamp<Clamped<T, R>> for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T> + Copy, 

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

impl<T, R> From<T> for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

fn from(value: T) -> Self

Performs the conversion.

impl<T, R> Eq for Clamped<T, R> where
    T: Copy + Eq + Num + PartialOrd,
    R: ClampedRange<T>, 

impl<T, R> Ord for Clamped<T, R> where
    T: Copy + Num + Ord + PartialOrd,
    R: ClampedRange<T>, 

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<T, R> PartialEq for Clamped<T, R> where
    T: Copy + Num + PartialEq + PartialOrd,
    R: ClampedRange<T>, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T, R> PartialEq<T> for Clamped<T, R> where
    T: Copy + Num + PartialEq + PartialOrd,
    R: ClampedRange<T>, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T, R> PartialOrd for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, R> PartialOrd<T> for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, R> Add for Clamped<T, R> where
    T: Add<Output = T> + Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<T, R> Add<T> for Clamped<T, R> where
    T: Add<Output = T> + Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: T) -> Self::Output

Performs the + operation.

impl<T, R> Deref for Clamped<T, R> where
    T: Copy + Num + PartialOrd,
    R: ClampedRange<T>, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, R> Div for Clamped<T, R> where
    T: Copy + Div<Output = T> + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<T, R> Div<T> for Clamped<T, R> where
    T: Copy + Div<Output = T> + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: T) -> Self::Output

Performs the / operation.

impl<T, R> Mul for Clamped<T, R> where
    T: Copy + Mul<Output = T> + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<T, R> Mul<T> for Clamped<T, R> where
    T: Copy + Mul<Output = T> + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self::Output

Performs the * operation.

impl<T, R> Neg for Clamped<T, R> where
    T: Copy + Neg<Output = T> + Num + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T, R> Sub for Clamped<T, R> where
    T: Copy + Num + Sub<Output = T> + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T, R> Sub<T> for Clamped<T, R> where
    T: Copy + Num + Sub<Output = T> + PartialOrd,
    R: ClampedRange<T>, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self::Output

Performs the - operation.