Struct NiceValue 

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

A strongly typed wrapper over nice values.

Implementations

impl NiceValue

pub const MIN: Self

pub const MAX: Self

pub fn new(value: i8) -> Self

Constructs a NiceValue from an integer. Values outside the valid range [-20, 19] are saturated.

pub const fn get(self) -> i8

Gets the inner primitive value.

Trait Implementations

impl Clone for NiceValue

fn clone(&self) -> NiceValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NiceValue

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

Formats the value using the given formatter.

impl Default for NiceValue

fn default() -> Self

Builds a default instance.

impl Ord for NiceValue

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

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

fn partial_cmp(&self, other: &NiceValue) -> 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 Copy for NiceValue

impl Eq for NiceValue

impl StructuralPartialEq for NiceValue