Struct Compress 

pub struct Compress<T: CompressFinite>(/* private fields */);

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

Implementations

impl<T: CompressFinite> Compress<T>

pub fn new(value: T) -> Self

Constructs a compressed wrapper over the given value.

pub fn expand(&self) -> T

Gets the expanded form of this compressed value.

Trait Implementations

impl<T: CompressFinite> Clone for Compress<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: CompressFinite> Finite for Compress<T>

const COUNT: usize = T::COUNT

The number of valid values of this type.

fn index_of(value: Self) -> usize

Gets a unique integer representation for the given value. This defines a 1-to-1 mapping between values of this type and non-negative integers less than Finite::COUNT.

fn nth(index: usize) -> Option<Self>

Gets the value with the given index as returned by Finite::index_of, or returns None if the index is out of bounds.

fn iter() -> FiniteIter<Self>

Iterates over all of the values of this type.

impl<K: CompressFinite + ArrayFinite<V>, V> Index<Compress<K>> for ArrayMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, index: Compress<K>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K: CompressFinite + ArrayFinite<V>, V> IndexMut<Compress<K>> for ArrayMap<K, V>

fn index_mut(&mut self, index: Compress<K>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Ord + CompressFinite> Ord for Compress<T>

where T::Index: Ord,

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

where T::Index: PartialEq,

fn eq(&self, other: &Compress<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: PartialOrd + CompressFinite> PartialOrd for Compress<T>

where T::Index: PartialOrd,

fn partial_cmp(&self, other: &Compress<T>) -> 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: CompressFinite + BitmapFinite> Set<Compress<T>> for BitmapSet<T>

fn contains(&self, value: Compress<T>) -> bool

Determines whether the set contains the given value.

fn include(&mut self, value: Compress<T>)

Ensures that the set includes the given value.

fn exclude(&mut self, value: Compress<T>)

Ensures that the set excludes the given value.

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

impl<T: Eq + CompressFinite> Eq for Compress<T>

where T::Index: Eq,

impl<T: CompressFinite> StructuralPartialEq for Compress<T>