Trait constriction::NonZeroBitArray

pub unsafe trait NonZeroBitArray: Copy + Display + Debug + Eq + Hash + 'static {
    type Base: BitArray<NonZero = Self>;

    fn new(n: Self::Base) -> Option<Self>;
    unsafe fn new_unchecked(n: Self::Base) -> Self;
    fn get(self) -> Self::Base;
}

A trait for bit strings like BitArray but with guaranteed nonzero values

Safety

Must guarantee that the value is indeed nonzero. Failing to do so could, e.g., cause a division by zero in entropy coders, which is undefined behavior.

Required Associated Types

type Base: BitArray<NonZero = Self>

Required Methods

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

Safety

The provided value n must be nonzero.

fn get(self) -> Self::Base

Implementations on Foreign Types

impl NonZeroBitArray for NonZeroU8

type Base = u8

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

impl NonZeroBitArray for NonZeroU16

type Base = u16

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

impl NonZeroBitArray for NonZeroU32

type Base = u32

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

impl NonZeroBitArray for NonZeroU64

type Base = u64

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

impl NonZeroBitArray for NonZeroUsize

type Base = usize

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

impl NonZeroBitArray for NonZeroU128

type Base = u128

fn new(n: Self::Base) -> Option<Self>

unsafe fn new_unchecked(n: Self::Base) -> Self

fn get(self) -> Self::Base

Implementors