Trait bee_ternary::raw::RawEncoding

pub trait RawEncoding {
    type Trit: Trit;
    type Buf: RawEncodingBuf<Slice = Self>;

    const TRITS_PER_BYTE: usize;

    fn empty() -> &'static Self;
    fn len(&self) -> usize;
    fn as_i8_slice(&self) -> &[i8];
    unsafe fn as_i8_slice_mut(&mut self) -> &mut [i8];
    unsafe fn get_unchecked(&self, index: usize) -> Self::Trit;
    unsafe fn set_unchecked(&mut self, index: usize, trit: Self::Trit);
    unsafe fn slice_unchecked(&self, range: Range<usize>) -> &Self;
    unsafe fn slice_unchecked_mut(&mut self, range: Range<usize>) -> &mut Self;
    fn is_valid(repr: i8) -> bool;
    unsafe fn from_raw_unchecked(b: &[i8], num_trits: usize) -> &Self;
    unsafe fn from_raw_unchecked_mut(b: &mut [i8], num_trits: usize) -> &mut Self;
}

A trait to be implemented by alternative trit encoding scheme slices.

Required Associated Types

type Trit: Trit

The type of trit associated with this trit encoding.

type Buf: RawEncodingBuf<Slice = Self>

The trit buffer encoding associated with this trit slice encoding.

Required Associated Constants

const TRITS_PER_BYTE: usize

The number of trits that fit into this trit slice encoding.

Required Methods

fn empty() -> &'static Self

Get an empty slice of this encoding

fn len(&self) -> usize

Get the number of trits in this buffer

fn as_i8_slice(&self) -> &[i8]

Interpret the raw data of this encoding as a slice of i8.

unsafe fn as_i8_slice_mut(&mut self) -> &mut [i8]

Interpret the raw data of this encoding as a mutable slice of i8.

unsafe fn get_unchecked(&self, index: usize) -> Self::Trit

Get the trit at the given index

unsafe fn set_unchecked(&mut self, index: usize, trit: Self::Trit)

Set the trit at the given index

unsafe fn slice_unchecked(&self, range: Range<usize>) -> &Self

Get a slice of this slice

unsafe fn slice_unchecked_mut(&mut self, range: Range<usize>) -> &mut Self

Get a mutable slice of this slice

fn is_valid(repr: i8) -> bool

Decide whether a byte is a valid series of trits in this encoding

unsafe fn from_raw_unchecked(b: &[i8], num_trits: usize) -> &Self

Unsafely reinterpret a slice of bytes as trit slice

unsafe fn from_raw_unchecked_mut(b: &mut [i8], num_trits: usize) -> &mut Self

Unsafely reinterpret a slice of bytes as trit slice

Implementors

impl RawEncoding for T2B1

type Trit = Btrit

type Buf = T2B1Buf

const TRITS_PER_BYTE: usize = 2usize

impl RawEncoding for T3B1

type Trit = Btrit

type Buf = T3B1Buf

const TRITS_PER_BYTE: usize = 3usize

impl RawEncoding for T4B1

type Trit = Btrit

type Buf = T4B1Buf

const TRITS_PER_BYTE: usize = 4usize

impl RawEncoding for T5B1

type Trit = Btrit

type Buf = T5B1Buf

const TRITS_PER_BYTE: usize = 5usize

impl<T> RawEncoding for T1B1<T>where
    T: Trit,

type Trit = T

type Buf = T1B1Buf<T>

const TRITS_PER_BYTE: usize = 1usize