Struct rubedo::crypto::Sha256Hash

pub struct Sha256Hash { /* private fields */ }

A SHA256 hash.

A formalised representation of a SHA256 hash, with support for common conversions, including serialisation and deserialisation using Serde.

The hash is stored internally as [u8; 32], which is the correct and most efficient format, as emitted by Sha256::digest().

The conversion to and from a String defaults to using hex strings rather than base64-encoded strings, because this is more common, due to it being a fixed-length string that is easy to read, verify, and transmit without any compatibility issues. However, base64 conversion functions are also provided for convenience in case that format is preferred.

Implementations

impl Sha256Hash

pub fn new<T: Into<Self>>(data: T) -> Self

Creates a new SHA256 hash instance.

Parameters

• data - The SHA256 hash as any type for which there is a From implementation.

See also

• ByteSized::from_bytes()

Trait Implementations

impl AsMut<[u8; 32]> for Sha256Hash

fn as_mut(&mut self) -> &mut [u8; 32]

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

impl AsRef<[u8; 32]> for Sha256Hash

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

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

impl ByteSized<32> for Sha256Hash

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

Returns a byte slice of the container’s contents.

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

Returns a copy of the container data as a fixed-length array of bytes.

fn from_bytes(bytes: [u8; 32]) -> Self

Constructs a ByteSized type from an array of bytes.

fn to_base64(&self) -> String

Returns the container data converted to a base64-encoded String.

fn from_base64(encoded: &str) -> Result<Self, DecodeError>

Converts a base64-encoded String to a ByteSized type.

fn to_hex(&self) -> String

Returns the container data converted to a hex-encoded String.

fn from_hex(encoded: &str) -> Result<Self, FromHexError>

Converts a hex-encoded String to a ByteSized.

fn to_vec(&self) -> Vec<u8>

Returns a copy of the container data converted to a vector of bytes.

impl ByteSizedMut<32> for Sha256Hash

fn as_mut_bytes(&mut self) -> &mut [u8; 32]

Returns a mutable reference to the container’s contents.

fn into_bytes(self) -> [u8; 32]

Returns the container as a fixed-length array of bytes.

fn into_vec(self) -> Vec<u8>

Returns the container as a vector of bytes.

impl Clone for Sha256Hash

fn clone(&self) -> Sha256Hash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sha256Hash

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

Formats the value using the given formatter.

impl Default for Sha256Hash

fn default() -> Sha256Hash

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sha256Hash

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

where D: Deserializer<'de>,

Deserialises the SHA256 hash from a String.

This method deserialises the SHA256 hash from hexadecimal string representation.

See also

• [$t::deserialize()]
• [$t::from_base64()]

impl Display for Sha256Hash

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

Formats the SHA256 hash for display.

This method serialises the SHA256 hash into hexadecimal string representation.

See also

• [$t::serialize()]
• [$t::to_base64()]

impl ForceFrom<&[u8]> for Sha256Hash

fn force_from(b: &[u8]) -> Self

Converts a &[u8] to a [$t].

Note that if the incoming [u8] is too long to fit, it will be truncated without error or warning. If there is not enough data, it will be padded with zeroes. If this situation needs checking, use try_from() instead.

impl<const N: usize> ForceFrom<&[u8; N]> for Sha256Hash

fn force_from(b: &[u8; N]) -> Self

Converts a &[u8; N] to a [$t].

Note that if the incoming [u8; N] is too long to fit, it will be truncated without error or warning. If there is not enough data, it will be padded with zeroes. If this situation needs checking, use try_from() instead.

impl ForceFrom<&Vec<u8>> for Sha256Hash

fn force_from(v: &Vec<u8>) -> Self

Converts a &Vec[u8] to a [$t].

Note that if the incoming Vec<u8> is too long to fit, it will be truncated without error or warning. If there is not enough data, it will be padded with zeroes. If this situation needs checking, use try_from() instead.

impl ForceFrom<Vec<u8>> for Sha256Hash

fn force_from(v: Vec<u8>) -> Self

Converts a Vec<u8> to a [$t].

Note that if the incoming Vec<u8> is too long to fit, it will be truncated without error or warning. If there is not enough data, it will be padded with zeroes. If this situation needs checking, use try_from() instead.

impl From<&[u8; 32]> for Sha256Hash

fn from(b: &[u8; 32]) -> Self

Converts a &[u8; $s] to a [$t].

impl From<&GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>> for Sha256Hash

fn from(a: &GenericArray<u8, U32>) -> Self

Converts a GenericArray<u8, $o> to a [$t].

impl From<[u8; 32]> for Sha256Hash

fn from(b: [u8; 32]) -> Self

Converts a [u8; $s] to a [$t].

impl From<GenericArray<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>> for Sha256Hash

fn from(a: GenericArray<u8, U32>) -> Self

Converts a GenericArray<u8, $o> to a [$t].

impl FromStr for Sha256Hash

type Err = ByteSizedError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Sha256Hash

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

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 Hashed for Sha256Hash

type Algorithm = CoreWrapper<CtVariableCoreWrapper<Sha256VarCore, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, OidSha256>>

The hashing algorithm to use produce the hash.

type OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

The output size of the hashing algorithm.

fn from_digest(output: GenericArray<u8, Self::OutputSize>) -> Self

Converts the output of the hashing algorithm to the Hashed type.

impl PartialEq<&[u8; 32]> for Sha256Hash

fn eq(&self, other: &&[u8; 32]) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<[u8; 32]> for Sha256Hash

fn eq(&self, other: &[u8; 32]) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Sha256Hash

fn eq(&self, other: &Sha256Hash) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Sha256Hash

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

where S: Serializer,

Serialises the SHA256 hash to a String.

This method serialises the SHA256 hash into hexadecimal string representation.

See also

• [$t::deserialize()]
• [$t::<Display>fmt()]
• [$t::to_base64()]

impl TryFrom<&[u8]> for Sha256Hash

fn try_from(b: &[u8]) -> Result<Self, Self::Error>

Converts a &[u8] to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<&String> for Sha256Hash

fn try_from(s: &String) -> Result<Self, Self::Error>

Converts a &String to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<&Vec<u8>> for Sha256Hash

fn try_from(v: &Vec<u8>) -> Result<Self, Self::Error>

Converts a &Vec[u8] to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<&str> for Sha256Hash

fn try_from(s: &str) -> Result<Self, Self::Error>

Converts a &str to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for Sha256Hash

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Converts a boxed string slice to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl<'a> TryFrom<Cow<'a, str>> for Sha256Hash

fn try_from(s: Cow<'a, str>) -> Result<Self, Self::Error>

Converts a clone-on-write string to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<String> for Sha256Hash

fn try_from(s: String) -> Result<Self, Self::Error>

Converts a String to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl TryFrom<Vec<u8>> for Sha256Hash

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

Converts a Vec<u8> to a [$t].

type Error = ByteSizedError

The type returned in the event of a conversion error.

impl Copy for Sha256Hash

impl Eq for Sha256Hash

impl StructuralPartialEq for Sha256Hash