Struct Hash

pub struct Hash { /* private fields */ }

Crytographically secure hash of data.

Offers constant time equality check (non-constant time ordinal checks). A version byte is used to indicate what hash algorithm should be used. Uses base58 encoding when displayed, unless overridden with hex formatting or debug formatting.

Supported Versions

• 1: Blake2B hash with 32 bytes of digest

Example

// Create a new hash from raw bytes
let hash = Hash::new(b"I am the entire data sequence");
println!("Hash(Base58): {}", hash);

Implementations

impl Hash

pub fn new(data: impl AsRef<[u8]>) -> Hash

Create a new hash from raw data, using the recommended algorithm.

pub fn with_version( data: impl AsRef<[u8]>, version: u8, ) -> Result<Hash, CryptoError>

Create a hash with a specific algorithm version. You should avoid this except when working through a upgrade process, where you may briefly need to support more than one version. Fails if the version isn’t supported.

pub fn version(&self) -> u8

Algorithm version associated with this hash.

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

The raw digest from the hash, without the version byte.

pub fn from_base58(s: &str) -> Result<Hash, CryptoError>

Attempt to parse a Base58-encoded hash type. Fails if the string isn’t valid Base58 or the hash itself isn’t valid.

pub fn to_base58(&self) -> String

Encode the hash as a Base58 string.

Trait Implementations

impl AsRef<[u8]> for Hash

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

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

fn ct_eq(&self, other: &Hash) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for Hash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hash

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl From<Hash> for Value

fn from(v: Hash) -> Self

Converts to this type from the input type.

impl<'a> From<Hash> for ValueRef<'a>

fn from(v: Hash) -> Self

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

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

Formats the value using the given formatter.

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Hash

type Error = CryptoError

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

type Error = Value

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ValueRef<'a>> for Hash

type Error = ValueRef<'a>

The type returned in the event of a conversion error.

fn try_from(v: ValueRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for Hash

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

Formats the value using the given formatter.

impl Eq for Hash