Struct TritBuf

Source

pub struct TritBuf<T: RawEncodingBuf = T1B1Buf<Btrit>>(/* private fields */);

Expand description

A buffer containing trits.

This type is roughly analogous to Vec or String. It supports pushing and popping trits and dereferences to Trits. It may be borrowed as a trit slice, either mutably or immutably.

Implementations§

Source §

impl<T: RawEncodingBuf> TritBuf<T>

Source

pub fn new() -> Self

Create a new empty TritBuf.

Source

pub fn with_capacity(cap: usize) -> Self

Create a new empty TritBuf, backed by the given capacity, cap. The resulting TritBuf will contain at least enough space to contain cap trits without needing to reallocate.

Source

pub fn filled(len: usize, trit: <T::Slice as RawEncoding>::Trit) -> Self

Create a new TritBuf of the given length, filled with copies of the provided trit.

Source

pub fn zeros(len: usize) -> Self

Create a new TritBuf of the given length, filled with zero trit.

Source

pub fn from_trits(trits: &[<T::Slice as RawEncoding>::Trit]) -> Self

Create a new TritBuf containing the trits from the given slice of trits.

Source

pub fn clear(&mut self)

Clears the buffer, removing all values. Note that this method has no effect on the allocated capacity of the buffer.

Source

pub fn push(&mut self, trit: <T::Slice as RawEncoding>::Trit)

Push a trit to the back of this TritBuf.

Source

pub fn pop(&mut self) -> Option<<T::Slice as RawEncoding>::Trit>

Pop a trit from the back of this TritBuf, returning it if successful.

Source

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

Append a trit slice to the end of this TritBuf.

Source

pub fn as_slice(&self) -> &Trits<T::Slice>

Extracts a trit slice containing the data within this buffer.

Note that TritBuf dereferences to Trits anyway, so it’s usually sufficient to take a reference to TritBuf or to just call &Trits methods on it rather than explicitly calling this method first.

Source

pub fn as_slice_mut(&mut self) -> &mut Trits<T::Slice>

Extracts a mutable trit slice containing the data within this buffer.

Note that TritBuf dereferences to Trits anyway, so it’s usually sufficient to take a reference to TritBuf or to just call &mut Trits methods on it rather explicitly calling this method first.

Source

pub fn capacity(&self) -> usize

Returns the number of trits the TritBuf can hold without reallocating.

Source §

impl TritBuf<T3B1Buf>

Source

pub fn pad_zeros(&mut self)

Pad the trit buffer with Btrit::Zero until the buffer’s length is a multiple of 3.

This method is often used in conjunction with Trits::as_trytes.

Source

pub fn padded_zeros(self) -> Self

Pad the trit buffer with Btrit::Zero until the buffer’s length is a multiple of 3.

This method is often used in conjunction with Trits::as_trytes.

Source §

impl<T: RawEncodingBuf> TritBuf<T>
where T::Slice: RawEncoding<Trit = Btrit>,

Source

pub fn from_i8s(trits: &[i8]) -> Result<Self, <Btrit as TryFrom<i8>>::Error>

Create a new TritBuf containing the trits given by the slice of i8s.

Source §

impl<T: RawEncodingBuf> TritBuf<T>
where T::Slice: RawEncoding<Trit = Utrit>,

Source

pub fn from_u8s(trits: &[u8]) -> Result<Self, <Btrit as TryFrom<u8>>::Error>

Create a new TritBuf containing the trits given by the slice of u8s.

Source §

impl<T> TritBuf<T1B1Buf<T>>
where T: Trit, T::Target: Trit,

Source

pub fn into_shifted(self) -> TritBuf<T1B1Buf<<T as ShiftTernary>::Target>>

Transform this TritBuf into a shifted representation. If the buffer contains balanced trits (Btrit), the returned buffer will contain unbalanced trits (Utrit).

Methods from Deref<Target = Trits<T::Slice>>§

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.