Struct ord_subset::OrdVar

pub struct OrdVar<T: PartialOrd + PartialEq>(_);

Wrapper to signal that the contained variables have a total order. It's illegal to compare two OrdVars that are not ordered. For this reason, it's unsafe to create OrdVars without checking. Checked constructors are available for OrdSubset types.

Panics

Panics when a.partial_cmp(b) returns None for two values a,b.

Methods

impl<T: PartialOrd + PartialEq> OrdVar<T>

pub fn new(data: T) -> OrdVar<T> where     T: Debug + OrdSubset,

Construct an OrdVar out of the argument.

Panics

Panics if the argument is outside of the total order.

pub fn new_checked(data: T) -> Option<OrdVar<T>> where     T: OrdSubset,

Constructs an Option<OrdVar> out of the argument. Returns None if the argument is outside the total order.

pub fn new_unchecked(data: T) -> OrdVar<T>

Constructs an OrdVar without validity check. Incorrectly constructed OrdVars may panic on calls to .cmp(). The comparison operators (>, >=, =, !=, <, <=) will not panic but may result in surprising behaviour.

pub fn into_inner(self) -> T

Trait Implementations

impl<T: PartialEq + PartialOrd + PartialEq> PartialEq for OrdVar<T>

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

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

fn ne(&self, other: &OrdVar<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + PartialOrd + PartialEq> PartialOrd for OrdVar<T>

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

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

fn lt(&self, other: &OrdVar<T>) -> bool

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

fn le(&self, other: &OrdVar<T>) -> bool

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

fn gt(&self, other: &OrdVar<T>) -> bool

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

fn ge(&self, other: &OrdVar<T>) -> bool

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

impl<T: Clone + PartialOrd + PartialEq> Clone for OrdVar<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + PartialOrd + PartialEq> Copy for OrdVar<T>

impl<T: Debug + PartialOrd + PartialEq> Debug for OrdVar<T>

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

Formats the value using the given formatter.

impl<T: Hash + PartialOrd + PartialEq> Hash for OrdVar<T>

fn hash<__HT: Hasher>(&self, state: &mut __HT)

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<T: PartialOrd + PartialEq> Eq for OrdVar<T>

impl<T: PartialOrd + PartialEq> Ord for OrdVar<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: PartialOrd + PartialEq> Deref for OrdVar<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: PartialOrd + PartialEq> AsRef<T> for OrdVar<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Default + OrdSubset + Debug> Default for OrdVar<T>

fn default() -> Self

Returns the "default value" for a type.