Struct Hash

pub struct Hash(/* private fields */);

A hash; the 32-byte output of a hashing algorithm.

This struct is used most often in solana-sdk and related crates to contain a SHA-256 hash, but may instead contain a blake3 hash, as created by the blake3 module (and used in Message::hash).

Implementations

impl Hash

pub fn new(hash_slice: &[u8]) -> Hash

pub const fn new_from_array(hash_array: [u8; 32]) -> Hash

pub fn new_unique() -> Hash

unique Hash for tests and benchmarks.

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

Trait Implementations

impl AbiExample for Hash

fn example() -> Hash

impl AsRef<[u8]> for Hash

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

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

impl BorshDeserialize for Hash

fn deserialize_reader<__R>(reader: &mut __R) -> Result<Hash, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for Hash

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for Hash

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

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

fn default() -> Hash

Returns the “default value” for a type.

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<[u8; 32]> for Hash

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

Converts to this type from the input type.

impl From<Hash> for JsValue

fn from(value: Hash) -> JsValue

Converts to this type from the input type.

impl From<Hash> for MessageHash

fn from(hash: Hash) -> MessageHash

Converts to this type from the input type.

impl FromStr for Hash

type Err = ParseHashError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Hash, <Hash as FromStr>::Err>

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

impl FromWasmAbi for Hash

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Hash

Recover a Self from Self::Abi.

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

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Hash

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Hash>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Hash as LongRefFromWasmAbi>::Abi, ) -> <Hash as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Hash

fn is_none(abi: &<Hash as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Hash

fn none() -> <Hash as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

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

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Hash>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <Hash as RefFromWasmAbi>::Abi, ) -> <Hash as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Hash

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Hash>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <Hash as RefMutFromWasmAbi>::Abi, ) -> <Hash as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Sanitize for Hash

fn sanitize(&self) -> Result<(), SanitizeError>

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

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<Hash, <Hash as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for Hash

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: <Hash as VectorFromWasmAbi>::Abi) -> Box<[Hash]>

impl VectorIntoWasmAbi for Hash

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Hash]>) -> <Hash as VectorIntoWasmAbi>::Abi

impl Zeroable for Hash

fn zeroed() -> Self

Calls zeroed.

impl Copy for Hash

impl Eq for Hash

impl Pod for Hash

impl StructuralPartialEq for Hash