Struct Bounded 

pub struct Bounded<T> { /* private fields */ }

A value bounded by a closed interval.

Implementations

impl<T: PartialOrd + Copy> Bounded<T>

pub fn new(value: T, range: RangeInclusive<T>) -> Self

Construct a new value bounded by the given range.

pub fn value(&self) -> T

pub fn min(&self) -> T

pub fn max(&self) -> T

pub fn map<U>(&mut self, f: impl Fn(T) -> U) -> Bounded<U>

pub fn is_max(&self) -> bool

Whether the value is at a maximum.

pub fn is_min(&self) -> bool

Whether the value is at a minimum.

pub fn is_above_min(&self) -> bool

Whether the value is above minimum.

impl<T: UNum> Bounded<T>

pub fn new_max(value: T) -> Self

Construct a new non-negative value with max set to be the initial value.

pub fn new_zero(max: T) -> Self

Construct a new non-negative value with a given max and initial value set to zero.

pub fn change(&mut self, delta: T)

Changes the value by a delta, but keeps it in the interval.

pub fn set(&mut self, value: T)

Sets the value after clamping it by the bounds.

impl<T: Float> Bounded<T>

pub fn get_ratio(&self) -> T

Returns a number in range 0..=1 representing the value in the interval where 0 = min, and 1 = max.

pub fn set_ratio(&mut self, ratio: T)

Trait Implementations

impl<T: Clone> Clone for Bounded<T>

fn clone(&self) -> Bounded<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Bounded<T>

impl<T: Debug> Debug for Bounded<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Bounded<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for Bounded<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.