Struct bee_ternary::Trits

source · [−]

#[repr(transparent)]
pub struct Trits<T: RawEncoding + ?Sized = T1B1<Btrit>>(_);

Expand description

A type that represents a buffer of trits of unknown length.

This type is roughly analogous to [T] or str. It is an unsized type and hence is rarely used directly. Instead, it’s more common to see it used from behind a reference (in a similar manner to &[T] and &str.

Implementations

source

impl<T> Trits<T> where
T: RawEncoding + ?Sized,

source

pub fn empty() -> &'static Self

Create an empty trit slice.

source

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

Interpret an (core::i8) slice as a trit slice with the given encoding without first checking that the slice is valid in the given encoding. The num_trits parameter is used to specify the exact length, in trits, that the slice should be taken to have. Providing a slice that is not valid for this encoding is undefined behaviour.

Panics

This function will panic if num_trits is more than can be represented with the slice in the given encoding.

Safety

This function must only be called with an i8 slice that is valid for this trit encoding given the specified num_trits length. Right now, this validity is not well-defined and so it is suggested that only i8 slices created from existing trit slices or trit buffers be used. Calling this function with an invalid i8 slice is undefined behaviour.

source

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

Interpret a mutable (core::i8) slice as a mutable trit slice with the given encoding without first checking that the slice is valid in the given encoding. The num_trits parameter is used to specify the exact length, in trits, that the slice should be taken to have. Providing a slice that is not valid for this encoding is undefined behaviour.

Panics

This function will panic if num_trits is more than can be represented with the slice in the given encoding.

Safety

This function must only be called with an i8 slice that is valid for this trit encoding given the specified num_trits length. Right now, this validity is not well-defined and so it is suggested that only i8 slices created from existing trit slices or trit buffers be used. Calling this function with an invalid i8 slice is undefined behaviour.

source

pub fn try_from_raw(raw: &[i8 ], num_trits: usize) -> Result<&Self, Error>

Interpret an (core::i8) slice as a trit slice with the given encoding, checking to ensure that the slice is valid in the given encoding. The num_trits parameter is used to specify the exact length, in trits, that the slice should be taken to have.

Panics

This function will panic if num_trits is more than can be represented with the slice in the given encoding.

source

pub fn try_from_raw_mut(
raw: &mut [i8 ],
num_trits: usize
) -> Result<&mut Self, Error>

Interpret a mutable (core::i8) slice as a mutable trit slice with the given encoding, checking to ensure that the slice is valid in the given encoding. The num_trits parameter is used to specify the exact length, in trits, that the slice should be taken to have.

Panics

This function will panic if num_trits is more than can be represented with the slice in the given encoding.

source

pub fn is_empty(&self) -> bool

Returns true if the trit slice is empty.

source

pub fn len(&self) -> usize

Returns the number of trits in this trit slice.

source

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

Interpret this slice as an (core::i8) slice.

Panics

This function will panic if the slice is not byte-aligned.

source

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

Interpret this slice as a mutable (core::i8) slice.

Panics

This function will panic if the slice is not byte-aligned.

Safety

This function is marked unsafe because modification of the trit slice in a manner that is not valid for this encoding is undefined behaviour.

source

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

Fetch the trit at the given index of this trit slice without first checking whether the index is in bounds. Providing an index that is not less than the length of this slice is undefined behaviour.

This is perhaps the ‘least bad’ unsafe function in this crate: not because any form of undefined behaviour is better or worse than another (after all, the point of undefined behaviour is that it is undefined) but because it’s the easiest to use correctly.

Safety

An index with a value less then the result of Trits::len must be used. Any other value is undefined behaviour.

source

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

Set the trit at the given index of this trit slice without first checking whether the index is in bounds. Providing an index that is not less than the length of this slice is undefined behaviour.

This is perhaps the ‘least bad’ unsafe function in this crate: not because any form of undefined behaviour is better or worse than another (after all, the point of undefined behaviour is that it is undefined) but because it’s the easiest to use correctly.

Safety

An index with a value less then the result of Trits::len must be used. Any other value is undefined behaviour.

source

pub fn get(&self, index: usize) -> Option<T::Trit>

Fetch the trit at the given index of this trit slice, if the index is valid.

source

pub fn set(&mut self, index: usize, trit: T::Trit)

Set the trit at the given index of this mutable trit slice, if the index is valid.

Panics

This function will panic if the index is not less than the length of this slice.

source

pub fn iter(
&self
) -> impl DoubleEndedIterator<Item = T::Trit> + ExactSizeIterator<Item = T::Trit> + '_

Returns an iterator over the trits in this slice.

Using this function is significantly faster than calling Trits::get in a loop and should be used where possible.

source

pub fn subslice(&self, range: Range<usize>) -> &Self

Returns a subslice of this slice with the given range of trits.

Panics

This function will panic if called with a range that contains indices outside this slice, or the start of the range is greater than its end.

source

pub fn subslice_mut(&mut self, range: Range<usize>) -> &mut Self

Returns a mutable subslice of this mutable slice with the given range of trits.

Panics

This function will panic if called with a range that contains indices outside this slice, or the start of the range is greater than its end.

source

pub fn copy_from<U: RawEncoding<Trit = T::Trit> + ?Sized>(
&mut self,
trits: &Trits
)

Copy the trits from a trit slice into this mutable trit slice (the encoding need not be equivalent).

Panics

This function will panic if the length of the slices are different.

source

pub fn fill(&mut self, trit: T::Trit)

Fill this mutable trit slice with copied of the given trit.

source

pub fn to_buf<U: RawEncodingBuf<Slice = T>>(&self) -> TritBuf

Copy the contents of this trit slice into a new TritBuf with the same encoding. This function is analogous to to_vec method implemented on ordinary slices.

source

pub fn chunks(
&self,
chunk_len: usize
) -> impl DoubleEndedIterator<Item = &Self> + ExactSizeIterator<Item = &Self> + '_

Return an iterator over distinct, non-overlapping subslices of this trit slice, each with the given chunk length. If the length of the trit slice is not a multiple of the given chunk length, the last slice provided by the iterator will be smaller to compensate.

Panics

This function will panic if the given chunk length is 0.

source

pub fn encode(&self) -> TritBuf where
U: RawEncodingBuf,
U::Slice: RawEncoding<Trit = T::Trit>,

Encode the contents of this trit slice into a TritBuf with a different encoding.

source

impl<T> Trits<T> where
T: RawEncoding<Trit = Btrit> + ?Sized,

source

pub fn iter_trytes(
&self
) -> impl DoubleEndedIterator<Item = Tryte> + ExactSizeIterator<Item = Tryte> + '_

Returns an iterator over the trytes represented within this slice.

For encodings that are representation-compatible with trytes, such as T3B1, use Trits::as_trytes instead since it is faster and more capable.

source

pub fn negate(&mut self)

Negate each trit in this buffer.

This has the effect of making the trit buffer negative when expressed in numeric form.

source

impl<T: Trit> Trits<T1B1<T>>

These functions are only implemented for trit slices with the T1B1 encoding because other encodings are compressed and do not support handing out references to their internal trits. T1B1 is an exception because its trits are strictly byte-aligned.

This fact also implies that T1B1 is the fastest encoding for general-purpose manipulation of trits.

source

pub fn as_raw_slice(&self) -> &[T]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

View this trit slice as an ordinary slice of trits.

source

pub fn as_raw_slice_mut(&mut self) -> &mut [T]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

View this mutable trit slice as an ordinary slice of mutable trits.

source

pub fn chunks_mut(
&mut self,
chunk_len: usize
) -> impl Iterator<Item = &mut Self> + '_

Return an iterator over distinct, non-overlapping mutable subslices of this mutable trit slice, each with the given chunk length. If the length of the trit slice is not a multiple of the given chunk length, the last slice provided by the iterator will be smaller to compensate.

Panics

This function will panic if the given chunk length is 0.

source

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns a mutable iterator over the trits in this slice.

Using this function is significantly faster than calling Trits::set in a loop and should be used where possible.

source

impl Trits<T3B1>

These functions are only implemented for trit slices with the T3B1 encoding because only the T3B1 encoding has a representation compatible with a slice of Trytes. If you find yourself commonly needing to convert between trits and trytes, T3B1 is the encoding to use.

source