Trait Linearize

pub unsafe trait Linearize {
    type Storage<T>: Storage<Self, T>;
    type CopyStorage<T>: CopyStorage<Self, T>
       where T: Copy;

    const LENGTH: usize;

    // Required methods
    fn linearize(&self) -> usize;
    unsafe fn from_linear_unchecked(linear: usize) -> Self
       where Self: Sized;
}

Types whose values can be enumerated.

Types that implement this trait define a bijection between themselves and an interval of the natural numbers.

Safety

• Self::Storage<T> must be [T; Self::LENGTH].
• Self::CopyStorage<T> must be [T; Self::LENGTH].
• Self::linearize must be a bijection to [0, Self::LENGTH).
• Self::from_linear_unchecked must be its inverse.

Note that the bijection implies that a roundtrip through linearize | from_linear_unchecked must return a value that is, for all intents and purposes, indistinguishable from the original value. The details of this depend on Self.

Required Associated Constants

const LENGTH: usize

The cardinality of this type.

Required Associated Types

type Storage<T>: Storage<Self, T>

[T; Self::LENGTH]

This type exists due to a limitation of the rust type system. In a future version of this crate, all uses of it will be replaced by [T; Self::LENGTH].

type CopyStorage<T>: CopyStorage<Self, T> where T: Copy

[T; Self::LENGTH]

This type exists due to a limitation of the rust type system. In a future version of this crate, all uses of it will be replaced by [T; Self::LENGTH].

Required Methods

fn linearize(&self) -> usize

Maps this value to the natural numbers.

This function is a bijection to the interval [0, Self::LENGTH).

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

The inverse of the linearize function.

Safety

linear must be less than Self::LENGTH.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Linearize for Ordering

const LENGTH: usize = 3usize

type Storage<T> = [T; 3]

type CopyStorage<T> = [T; 3] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for Infallible

const LENGTH: usize = 0usize

type Storage<T> = [T; 0]

type CopyStorage<T> = [T; 0] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(_linear: usize) -> Self

where Self: Sized,

impl Linearize for Alignment

const LENGTH: usize = 3usize

type Storage<T> = [T; 3]

type CopyStorage<T> = [T; 3] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for FpCategory

const LENGTH: usize = 5usize

type Storage<T> = [T; 5]

type CopyStorage<T> = [T; 5] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for Shutdown

const LENGTH: usize = 3usize

type Storage<T> = [T; 3]

type CopyStorage<T> = [T; 3] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for bool

const LENGTH: usize = 2usize

type Storage<T> = [T; 2]

type CopyStorage<T> = [T; 2] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for i8

const LENGTH: usize = 256usize

type Storage<T> = [T; 256]

type CopyStorage<T> = [T; 256] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

impl Linearize for i16

const LENGTH: usize = 65_536usize

type Storage<T> = [T; 65536]

type CopyStorage<T> = [T; 65536] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

impl Linearize for i32

const LENGTH: usize = 4_294_967_296usize

type Storage<T> = [T; 4294967296]

type CopyStorage<T> = [T; 4294967296] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

impl Linearize for u8

const LENGTH: usize = 256usize

type Storage<T> = [T; 256]

type CopyStorage<T> = [T; 256] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for u16

const LENGTH: usize = 65_536usize

type Storage<T> = [T; 65536]

type CopyStorage<T> = [T; 65536] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for u32

const LENGTH: usize = 4_294_967_296usize

type Storage<T> = [T; 4294967296]

type CopyStorage<T> = [T; 4294967296] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(linear: usize) -> Self

where Self: Sized,

impl Linearize for ()

const LENGTH: usize = 1usize

type Storage<T> = [T; 1]

type CopyStorage<T> = [T; 1] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(_linear: usize) -> Self

where Self: Sized,

impl Linearize for PhantomPinned

const LENGTH: usize = 1usize

type Storage<T> = [T; 1]

type CopyStorage<T> = [T; 1] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(_linear: usize) -> Self

where Self: Sized,

impl<X> Linearize for PhantomData<X>

where X: ?Sized,

const LENGTH: usize = 1usize

type Storage<T> = [T; 1]

type CopyStorage<T> = [T; 1] where T: Copy

fn linearize(&self) -> usize

unsafe fn from_linear_unchecked(_linear: usize) -> Self

where Self: Sized,

Implementors

impl Linearize for FootnoteType