Struct bee_ternary::TritBuf

#[repr(transparent)]
pub struct TritBuf<T: RawEncodingBuf = T1B1Buf<Btrit>>(_);

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

impl<T: RawEncodingBuf> TritBuf<T>

pub fn new() -> Self

Create a new empty TritBuf.

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.

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.

pub fn zeros(len: usize) -> Self

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

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

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

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.

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

Push a trit to the back of this TritBuf.

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

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

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

Append a trit slice to the end of this TritBuf.

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.

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.

pub fn capacity(&self) -> usize

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

impl TritBuf<T3B1Buf>

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.

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.

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

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.

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

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.

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

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>>

pub fn is_empty(&self) -> bool

Returns true if the trit slice is empty.

pub fn len(&self) -> usize

Returns the number of trits in this trit slice.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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

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

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

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.

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.

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

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

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.

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.

pub fn as_raw_slice(&self) -> &[T]

View this trit slice as an ordinary slice of trits.

pub fn as_raw_slice_mut(&mut self) -> &mut [T]

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

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.

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.

pub fn as_trytes(&self) -> &[Tryte]

Interpret this trit slice as a Tryte slice.

Panics

This function will panic if the length of the slice is not a multiple of 3, or if the slice is not byte-aligned.

pub fn as_trytes_mut(&mut self) -> &mut [Tryte]

Interpret this mutable trit slice as a mutable Tryte slice.

Panics

This function will panic if the length of the slice is not a multiple of 3, or if the slice is not byte-aligned.

Trait Implementations

impl<T: RawEncodingBuf> Borrow<Trits<<T as RawEncodingBuf>::Slice>> for TritBuf<T>

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

Immutably borrows from an owned value.

impl<T: RawEncodingBuf> BorrowMut<Trits<<T as RawEncodingBuf>::Slice>> for TritBuf<T>

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

Mutably borrows from an owned value.

impl<T: Clone + RawEncodingBuf> Clone for TritBuf<T>

fn clone(&self) -> TritBuf<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: RawEncodingBuf> Debug for TritBuf<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: RawEncodingBuf> Default for TritBuf<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: RawEncodingBuf> Deref for TritBuf<T>

type Target = Trits<T::Slice>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: RawEncodingBuf> DerefMut for TritBuf<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T: RawEncodingBuf> Deserialize<'de> for TritBuf<T> where
    <T::Slice as RawEncoding>::Trit: Deserialize<'de>, 

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: RawEncodingBuf> Display for TritBuf<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

fn from(x: i128) -> Self

Converts to this type from the input type.

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

fn from(x: i16) -> Self

Converts to this type from the input type.

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

fn from(x: i32) -> Self

Converts to this type from the input type.

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

fn from(x: i64) -> Self

Converts to this type from the input type.

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

fn from(x: i8) -> Self

Converts to this type from the input type.

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

fn from(x: u128) -> Self

Converts to this type from the input type.

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

fn from(x: u16) -> Self

Converts to this type from the input type.

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

fn from(x: u32) -> Self

Converts to this type from the input type.

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

fn from(x: u64) -> Self

Converts to this type from the input type.

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

fn from(x: u8) -> Self

Converts to this type from the input type.

impl<T: RawEncodingBuf> FromIterator<<<T as RawEncodingBuf>::Slice as RawEncoding>::Trit> for TritBuf<T>

fn from_iter<I: IntoIterator<Item = <T::Slice as RawEncoding>::Trit>>(
    iter: I
) -> Self

Creates a value from an iterator.

impl<T> Hash for TritBuf<T> where
    T: RawEncodingBuf,
    T::Slice: Hash, 

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

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

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: RawEncodingBuf, U: RawEncodingBuf> PartialEq<TritBuf<U>> for TritBuf<T> where
    T::Slice: RawEncoding,
    U::Slice: RawEncoding<Trit = <T::Slice as RawEncoding>::Trit>, 

fn eq(&self, other: &TritBuf<U>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, U> PartialOrd<TritBuf<U>> for TritBuf<T> where
    T: RawEncodingBuf,
    U: RawEncodingBuf,
    U::Slice: RawEncoding<Trit = <T::Slice as RawEncoding>::Trit>,
    <T::Slice as RawEncoding>::Trit: PartialOrd, 

fn partial_cmp(&self, other: &TritBuf<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: RawEncodingBuf> Serialize for TritBuf<T> where
    <T::Slice as RawEncoding>::Trit: Serialize, 

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: RawEncodingBuf> Eq for TritBuf<T> where
    T::Slice: RawEncoding,