Struct bee_crypto::ternary::Hash

pub struct Hash(_);

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

Ternary cryptographic hash.

Implementations

impl Hash

pub fn zeros() -> Self

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

Creates a hash filled with zeros.

pub fn as_trits(&self) -> &Trits<T1B1>

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

Interpret the Hash as a trit slice.

pub fn as_trits_mut(&mut self) -> &mut Trits<T1B1>

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

Interpret the Hash as a mutable trit slice.

pub fn weight(&self) -> u8

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

Returns the weight - number of ending 0s - of the Hash.

Methods from Deref<Target = Trits<T1B1>>

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 as RawEncoding>::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 as RawEncoding>::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 as RawEncoding>::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 as RawEncoding>::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 + ExactSizeIterator

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>) -> &Trits<T>

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

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>(&mut self, trits: &Trits<U>) where
    U: RawEncoding<Trit = <T as RawEncoding>::Trit> + ?Sized, 

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 as RawEncoding>::Trit)

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

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

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

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 as RawEncodingBuf>::Slice: RawEncoding,
    <<U as RawEncodingBuf>::Slice as RawEncoding>::Trit == <T as RawEncoding>::Trit, 

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

pub fn iter_trytes(&self) -> impl DoubleEndedIterator + ExactSizeIterator

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 Trits<T1B1<T>>>

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 Clone for Hash

fn clone(&self) -> Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hash

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

Formats the value using the given formatter.

impl Deref for Hash

type Target = Trits<T1B1>

The resulting type after dereferencing.

fn deref(&self) -> &Trits<T1B1>

Dereferences the value.

impl DerefMut for Hash

fn deref_mut(&mut self) -> &mut Trits<T1B1>

Mutably dereferences the value.

impl Display for Hash

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

Formats the value using the given formatter.

impl Hash for 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 PartialEq<Hash> for Hash

fn eq(&self, other: &Self) -> 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<'a, T: RawEncoding<Trit = Btrit>> TryFrom<&'a Trits<T>> for Hash

type Error = Error

The type returned in the event of a conversion error.

fn try_from(trits: &'a Trits<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Hash

impl Eq for Hash