Module constmuck::contiguous

Functions for converting types that implement Contiguous into and from their integer representation.

Related: the IsContiguous type.

Example

Converting an enum both from and into an integer.

use constmuck::{Contiguous, IsContiguous, contiguous, infer};

#[repr(u32)]
#[derive(Debug, PartialEq, Copy, Clone)]
enum Side {
    Front = 0,
    Back = 1,
    Sides = 2,
}

unsafe impl Contiguous for Side {
   type Int = u32;

   const MIN_VALUE: u32 = 0;
   const MAX_VALUE: u32 = 2;
}

const SIDE_INTS: [u32; 3] = [
    contiguous::into_integer(Side::Front, &infer!()),
    contiguous::into_integer(Side::Back, &infer!()),
    contiguous::into_integer(Side::Sides, &infer!()),
];
assert_eq!(SIDE_INTS, [0, 1, 2]);

const SIDE_OPTS: [Option<Side>; 4] = [
    contiguous::from_u32(0, infer!()),
    contiguous::from_u32(1, IsContiguous!()),
    contiguous::from_u32(2, IsContiguous!(Side)),
    contiguous::from_u32(3, IsContiguous!(Side, u32)),
];

assert_eq!(
    SIDE_OPTS,
    [Some(Side::Front), Some(Side::Back), Some(Side::Sides), None],
);

Re-exports

pub use crate::IsContiguous;

pub use crate::IsContiguous;

Structs

FromInteger

Converts IntRepr to T if it’s between the minimum and maximum values for T, otherwise returns None.

Functions

from_i8

Converts ìnteger: i8 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_i16

Converts ìnteger: i16 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_i32

Converts ìnteger: i32 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_i64

Converts ìnteger: i64 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_i128

Converts ìnteger: i128 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_isize

Converts ìnteger: isize to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_u8

Converts integer: u8 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_u16

Converts ìnteger: u16 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_u32

Converts ìnteger: u32 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_u64

Converts ìnteger: u64 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_u128

Converts ìnteger: u128 to T if it’s between the minimum and maximum values for T, otherwise returns None.

from_usize

Converts ìnteger: usize to T if it’s between the minimum and maximum values for T, otherwise returns None.

into_integer

Converts value: T into IntRepr (its integer representation).