Struct KeyHash 

pub struct KeyHash(pub HashBytes);

A hashed key used to index a JellyfishMerkleTree.

🚨 Danger 🚨

ics23 non-existence proofs require that all key preimages are non-empty. If you plan to use ics23 non-existence proofs, you must ensure that keys are non-empty before creating KeyHashes.

The JellyfishMerkleTree only stores key hashes, not full keys.

Tuple Fields

0: HashBytes

Implementations

impl KeyHash

pub fn with<H: SimpleHasher>(key: impl AsRef<[u8]>) -> Self

Hash the provided key with the provided hasher and return a new KeyHash.

🚨 Danger 🚨

If you will use ics23 non-existence proofs, you must ensure that the key is non-empty before calling this function.

Trait Implementations

impl Clone for KeyHash

fn clone(&self) -> KeyHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyHash

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

Formats the value using the given formatter.

impl Decode for KeyHash

fn decode_ext( reader: &mut impl Read, dedupe_decoder: Option<&mut DedupeDecoder>, ) -> Result<Self>

Decodes Self from reader, optionally using DedupeDecoder.

fn decode_len(reader: &mut impl Read) -> Result<usize, Error>

Decodes a collection length previously encoded with Encode::encode_len.

fn decode_discriminant(reader: &mut impl Read) -> Result<usize, Error>

Decodes an enum discriminant previously encoded with Encode::encode_discriminant.

fn decode(reader: &mut impl Read) -> Result<Self, Error>

where Self: Sized,

Convenience wrapper around Decode::decode_ext without deduplication.

impl<'de> Deserialize<'de> for KeyHash

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for KeyHash

fn encode_ext( &self, writer: &mut impl Write, dedupe_encoder: Option<&mut DedupeEncoder>, ) -> Result<usize>

Encodes self to writer, optionally using DedupeEncoder.

fn encode_len(len: usize, writer: &mut impl Write) -> Result<usize, Error>

Encodes a collection length in a compact form.

fn encode_discriminant( discriminant: usize, writer: &mut impl Write, ) -> Result<usize, Error>

Encodes an enum discriminant in a compact, consistent form.

fn encode(&self, writer: &mut impl Write) -> Result<usize, Error>

Convenience wrapper around Encode::encode_ext without deduplication.

impl Hash for KeyHash

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 Ord for KeyHash

fn cmp(&self, other: &KeyHash) -> 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 KeyHash

fn eq(&self, other: &KeyHash) -> 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 KeyHash

fn partial_cmp(&self, other: &KeyHash) -> 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 KeyHash

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KeyHash

impl Eq for KeyHash

impl StructuralPartialEq for KeyHash