Struct Hash 

pub struct Hash { /* private fields */ }

Implementations

impl Hash

pub fn compact(&self) -> &[u8]

Produces a compact binary form of this [Hash].

To turn the binary form back into a [Hash], use Hash::validate.

impl Hash

pub fn data_max_len(&self) -> PackedInt

impl Hash

pub fn digest(&self) -> &[u8; 32]

impl Hash

pub fn parity(&self) -> &[u8; 14]

impl Hash

pub fn to_string(&self) -> String

Returns the base64-encoded representation of this [Hash].

This method uses a single allocation, avoiding the potential reallocations of Display.

impl Hash

pub fn validate(bytes: impl AsRef<[u8]>) -> Result<Hash, HashValidationError>

impl Hash

pub fn hash(data: impl AsRef<[u8]>) -> Result<Hash, HashError>

Calculates the [Hash] of data.

Errors

• HashError::RSGenerateParityError is returned if generating parity fails.

pub fn validate_bin_vec(hash: &mut Vec<u8>) -> Result<Hash, HashValidationError>

Validates and corrects a binary-encoded [Hash].
The correction happens on the provided Vec.

Errors

• HashValidationError::RSDecodeError is returned if the hash is unrecoverable.

Trait Implementations

impl Clone for Hash

fn clone(&self) -> Hash

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for Hash

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

Formats the value using the given formatter.

impl From<&Hash> for Vec<u8>

fn from(value: &Hash) -> Vec<u8>

Converts to this type from the input type.

impl From<Hash> for Vec<u8>

fn from(value: Hash) -> Vec<u8>

Converts to this type from the input type.

impl Hash for Hash

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Hash

fn cmp(&self, other: &Hash) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Hash

fn eq(&self, other: &Hash) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Hash

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&[u8]> for Hash

type Error = HashValidationError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Hash, <Hash as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&str> for Hash

type Error = HashValidationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Hash, <Hash as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for Hash

impl Eq for Hash