Struct Hash 

pub struct Hash { /* private fields */ }

A cryptographic hash value with its associated algorithm.

This type represents the result of applying a cryptographic hash function to some data. It stores both the resulting hash value and the algorithm used to create it.

Implementations

impl Hash

pub const fn new(algorithm: HashAlgorithm, bytes: ByteVec) -> Self

Creates a new hash value with the specified algorithm and bytes.

Arguments

• algorithm - The hash algorithm used to create this hash
• bytes - The raw hash value bytes

pub const fn get_bytes(&self) -> &ByteVec

Returns a reference to the raw hash value bytes.

pub const fn get_algorithm(&self) -> HashAlgorithm

Returns the algorithm used to create this hash.

pub fn verify(&self, bytes: Arc<ByteVec>) -> bool

Verifies that this hash matches the hash of the provided bytes.

Arguments

• bytes - The bytes to verify against this hash

Returns

true if the hash of the provided bytes matches this hash, false otherwise

pub fn try_to_byte_vec(&self) -> Result<Arc<ByteVec>, SerialiseError>

Converts this hash to a ByteVec suitable for encoding.

Errors

Returns SerialiseError if the hash cannot be converted to bytes.

pub fn try_hash( byte_vec: Arc<ByteVec>, algorithm: HashAlgorithm, ) -> Result<Arc<Self>, SerialiseError>

Computes a hash of the provided bytes using the given algorithm.

Errors

Returns SerialiseError if hashing fails.

Trait Implementations

impl Debug for Hash

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

Formats the value using the given formatter.

impl Decodable for Hash

fn try_decode(encoded_string: EncodedString) -> Result<Self, SerialiseError>

where Self: Sized,

Attempts to decode an encoded string into this type.

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<Arc<ByteVec>> for Hash

type Error = SerialiseError

The type returned in the event of a conversion error.

fn try_from(value: Arc<ByteVec>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryIntoByteVec for Hash

fn try_into_byte_vec(value: Arc<Self>) -> Result<Arc<ByteVec>, SerialiseError>

Converts Self to a ByteVec.

impl Eq for Hash

impl StructuralPartialEq for Hash