Struct totally_ordered::TotallyOrdered

#[repr(transparent)]
pub struct TotallyOrdered<F: TotallyOrderable>(pub F);

An ABI-transparent newtype wrapper around types that adds Ord + Eq to TotallyOrderable types (f32 and f64).

Methods

impl<F: TotallyOrderable> TotallyOrdered<F>

pub fn new(v: F) -> Self

Creates a wrapped value from an inner value

pub fn new_slice(s: &[F]) -> &[Self]

Creates a wrapped slice without copying data. Not implemented as From<&[F]> for &[Self] as slices are always foreign.

Follows the usual borrowing rules:

let mut values = [1.0, 2.0, 3.0];
let values_to = TotallyOrdered::new_slice(&values);
values[2] = 4.0; // error, can't mutate while borrowed
assert_eq!(values_to[2], TotallyOrdered::new(3.0));

pub fn new_slice_mut(s: &mut [F]) -> &mut [Self]

Creates a mutable wrapped slice without copying data. Not implemented as From<&mut [F]> for &mut [Self] as slices are always foreign.

Follows the usual borrowing rules:

let mut values = [3.0, 2.0, 1.0];
let values_to = TotallyOrdered::new_slice_mut(&mut values);
assert_eq!(values[2], 1.0); // error, can't borrow while mutably borrowed
values_to.sort();

Trait Implementations

impl<F: Clone + TotallyOrderable> Clone for TotallyOrdered<F>

fn clone(&self) -> TotallyOrdered<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Copy + TotallyOrderable> Copy for TotallyOrdered<F>

impl<F: Debug + TotallyOrderable> Debug for TotallyOrdered<F>

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

Formats the value using the given formatter.

impl<F: Default + TotallyOrderable> Default for TotallyOrdered<F>

fn default() -> TotallyOrdered<F>

Returns the "default value" for a type.

impl<F: TotallyOrderable> Eq for TotallyOrdered<F>

impl<'a, F: TotallyOrderable> From<&'a F> for &'a TotallyOrdered<F>

fn from(v: &F) -> Self

The explicit lifetime bound ensures that both From

let mut value : f32 = 1.0;
let value_to : &TotallyOrdered<_> = From::from(&value);
value = 2.0; // error, can't mutate while borrowed
assert_eq!(*value_to, TotallyOrdered::new(1.0));

and Into

let mut value : f32 = 1.0;
let value_to : &TotallyOrdered<_> = (&value).into();
value = 2.0; // error, can't mutate while borrowed
assert_eq!(*value_to, TotallyOrdered::new(1.0));

respect the lifetime of the borrow on the original value.

impl<'a, F: TotallyOrderable> From<&'a mut F> for &'a mut TotallyOrdered<F>

fn from(v: &mut F) -> Self

The explicit lifetime bound ensures that both From

let mut value : f32 = 1.0;
let value_to : &mut TotallyOrdered<_> = From::from(&mut value);
assert_eq!(value, 1.0); // error, can't borrow while mutably borrowed
*value_to = TotallyOrdered::new(2.0);

and Into

let mut value : f32 = 1.0;
let value_to : &mut TotallyOrdered<_> = (&mut value).into();
assert_eq!(value, 1.0); // error, can't borrow while mutably borrowed
*value_to = TotallyOrdered::new(2.0);

respect the lifetime of the mutable borrow on the original value.

impl<F: TotallyOrderable> From<F> for TotallyOrdered<F>

fn from(v: F) -> Self

Performs the conversion.

impl<F: TotallyOrderable> Hash for TotallyOrdered<F>

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, 

Feeds a slice of this type into the given [Hasher].

impl<F: TotallyOrderable> Ord for TotallyOrdered<F>

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<F: TotallyOrderable> PartialEq<TotallyOrdered<F>> for TotallyOrdered<F>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<F: TotallyOrderable> PartialOrd<TotallyOrdered<F>> for TotallyOrdered<F>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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