cantor 0.1.3

A general toolkit for working with types that have a small number of values
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use crate::uint::Unsigned;
use crate::*;

/// A compressed representation of a value of type `T`, implemented by storing its index
/// according [`Finite::index_of`] using the smallest integer type possible.
///
/// # Example
/// ```
/// use cantor::*;
/// use core::mem::size_of_val;
///
/// #[derive(Finite, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug)]
/// enum MyType {
///     A,
///     B(bool),
///     C(bool, bool)
/// }
///
/// let value = MyType::B(false);
/// assert_eq!(size_of_val(&value), 3);
/// let compressed = compress(value);
/// assert_eq!(size_of_val(&compressed), 1);
/// assert_eq!(value, compressed.expand());
/// ```
#[derive(PartialEq, Eq, PartialOrd, Ord)]
pub struct Compress<T: CompressFinite>(T::Index);

/// The trait required to use [`Compress`] on a type. Theoretically, this should apply to all
/// [`Finite`] types, but due to limitations in const generics, a blanket implementation is not
/// currently possible.
///
/// This is automatically implemented on concrete types that derive [`Finite`]. It can also be
/// implemented on a particular concrete type using [`impl_concrete_finite`].
#[doc(hidden)]
#[allow(clippy::missing_safety_doc)] // Should never be manually implemented.
pub unsafe trait CompressFinite: Finite {
    #[allow(missing_docs)]
    type Index: Unsigned;
}

impl<T: CompressFinite> Compress<T> {
    /// Constructs a compressed wrapper over the given value.
    pub fn new(value: T) -> Self {
        Compress(T::Index::from_usize_unchecked(T::index_of(value)))
    }

    /// Gets the expanded form of this compressed value.
    pub fn expand(&self) -> T {
        unsafe { T::nth(self.0.to_usize()).unwrap_unchecked() }
    }
}

/// Gets a compressed representation of the given value.
pub fn compress<T: CompressFinite>(value: T) -> Compress<T> {
    Compress::new(value)
}

unsafe impl<T: CompressFinite> Finite for Compress<T> {
    const COUNT: usize = T::COUNT;

    fn index_of(value: Self) -> usize {
        value.0.to_usize()
    }

    fn nth(index: usize) -> Option<Self> {
        if index < Self::COUNT {
            Some(Compress(T::Index::from_usize_unchecked(index)))
        } else {
            None
        }
    }
}

impl<T: CompressFinite> Clone for Compress<T> {
    fn clone(&self) -> Self {
        Self(self.0)
    }
}

impl<T: CompressFinite> Copy for Compress<T> { }

#[test]
fn test_compress_zst() {
    assert_eq!(core::mem::size_of::<()>(), 0);
}