Struct Ordered

#[repr(transparent)]
pub struct Ordered<T>(pub T);

A wrapper type that implements PartialOrd and Ord.

Examples

use core::cmp::Ordering;
use ordered::{ArbitraryOrd, Ordered};

/// A point in 2D space.
///
/// We do not want users to be able to write `a < b` because it is not well defined.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
struct Point {
    x: u32,
    y: u32,
}

impl ArbitraryOrd for Point {
    fn arbitrary_cmp(&self, other: &Self) -> Ordering {
        // Just use whatever order tuple cmp gives us.
        (self.x, self.y).cmp(&(other.x, other.y))
    }
}

let point = Point { x: 0, y: 1 };
let ordered = Ordered(point);

assert_eq!(*ordered, point); // Use `ops::Deref`.
assert_eq!(&ordered.0, ordered.as_ref()); // Use the public inner field or `AsRef`.

Tuple Fields

0: T

Implementations

impl<T> Ordered<T>

pub const fn new(inner: T) -> Self

Creates a new wrapped ordered type.

The inner type is public so this function is never explicitly needed.

pub fn from_ref(value: &T) -> &Self

Creates an Ordered<T> from a reference.

This allows: let found = map.get(Ordered::from_ref(&a));

Examples found in repository

examples/point.rs (line 21)

fn main() {
    let mut map = BTreeMap::new();

    let a = Point { x: 2, y: 3 };
    let b = Point { x: 1, y: 5 };

    map.insert(Ordered::from(a), "some interesting value");
    map.insert(Ordered::from(b), "some other interesting value");

    println!();
    println!("Looking in map for key: {}", a);

    let found = map.get(Ordered::from_ref(&a)).expect("handle item not found");

    println!("Found it, with value: {}", found);
}

pub const fn as_inner(&self) -> &T

👎Deprecated since 0.3.0: use ops::Deref instead

Returns a reference to the inner object.

We also implement core::borrow::Borrow so this function is never explicitly needed.

pub fn into_inner(self) -> T

👎Deprecated since 0.3.0: use ops::Deref instead

Returns the inner object.

We also implement core::ops::Deref so this function is never explicitly needed.

Trait Implementations

impl<T> AsMut<T> for Ordered<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Ordered<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<T> for Ordered<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for Ordered<T>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: Clone> Clone for Ordered<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ordered<T>

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

Formats the value using the given formatter.

impl<T> Deref for Ordered<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Ordered<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Display> Display for Ordered<T>

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

Formats the value using the given formatter.

impl<T> From<T> for Ordered<T>

fn from(inner: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Ordered<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ArbitraryOrd + Eq> Ord for Ordered<T>

fn cmp(&self, other: &Self) -> 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<T: PartialEq> PartialEq for Ordered<T>

fn eq(&self, other: &Ordered<T>) -> 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<T: ArbitraryOrd> PartialOrd for Ordered<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

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<T: Copy> Copy for Ordered<T>

impl<T: Eq> Eq for Ordered<T>

impl<T> StructuralPartialEq for Ordered<T>