ordered 0.4.0

A wrapper for adding arbitrary partial/total order to a type.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Showcase using `Ordered` with an unordered type as a `BTreeMap` key.

use std::cmp::Ordering;
use std::collections::BTreeMap;
use std::fmt;

use ordered::{ArbitraryOrd, Ordered};

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);
}

/// 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 { (self.x, self.y).cmp(&(other.x, other.y)) }
}

impl fmt::Display for Point {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "({}, {})", self.x, self.y) }
}