Struct hdk::prelude::HoloHash

pub struct HoloHash<T> where
    T: HashType,  { /* fields omitted */ }

A HoloHash contains a vector of 36 bytes representing a 32-byte blake2b hash plus 4 bytes representing a DHT location. It also contains a zero-sized type which specifies what it is a hash of.

There is custom de/serialization implemented in [ser.rs]

Implementations

impl<T> HoloHash<T> where
    T: HashType, 

pub fn from_raw_39(hash: Vec<u8, Global>) -> Result<HoloHash<T>, HoloHashError>

Raw constructor: Create a HoloHash from 39 bytes, using the prefix bytes to determine the hash_type

pub fn from_raw_39_panicky(hash: Vec<u8, Global>) -> HoloHash<T>

Raw constructor: Create a HoloHash from 39 bytes, using the prefix bytes to determine the hash_type. Panics if hash_type does not match.

pub fn from_raw_36_and_type(bytes: Vec<u8, Global>, hash_type: T) -> HoloHash<T>

Use a precomputed hash + location byte array in vec form, along with a type, to construct a hash. Used in this crate only, for testing.

pub fn retype<TT>(self, hash_type: TT) -> HoloHash<TT> where
    TT: HashType, 

Change the type of this HoloHash, keeping the same bytes

pub fn hash_type(&self) -> &T

The HashType of this hash

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

Get the raw 39-byte Vec including the 3 byte prefix, base 32 bytes, and the 4 byte loc

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

Get 36-byte Vec which excludes the 3 byte prefix

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

Fetch just the core 32 bytes (without the 4 location bytes)

pub fn get_loc(&self) -> u32

Fetch the holo dht location for this hash

pub fn into_inner(self) -> Vec<u8, Global>

consume into the inner byte vector

impl<T> HoloHash<T> where
    T: HashType, 

pub fn from_raw_32_and_type(hash: Vec<u8, Global>, hash_type: T) -> HoloHash<T>

Construct a HoloHash from a 32-byte hash. The 3 prefix bytes will be added based on the provided HashType, and the 4 location bytes will be computed.

For convenience, 36 bytes can also be passed in, in which case the location bytes will used as provided, not computed.

impl<P> HoloHash<P> where
    P: PrimitiveHashType, 

pub fn from_raw_36(hash: Vec<u8, Global>) -> HoloHash<P>

Construct from 36 raw bytes, using the known PrimitiveHashType

pub fn from_raw_32(hash: Vec<u8, Global>) -> HoloHash<P>

Construct a HoloHash from a prehashed raw 32-byte slice. The location bytes will be calculated.

impl<T> HoloHash<T> where
    T: HashTypeSync, 

pub fn with_data_sync<C>(content: &C) -> HoloHash<T> where
    C: HashableContent<HashType = T>, 

Synchronously hash a reference to the given content to produce a HoloHash If the content is larger than MAX_HASHABLE_CONTENT_LEN, this will panic!

impl<T> HoloHash<T> where
    T: HashTypeAsync, 

pub async fn with_data<C>(content: &'_ C) -> HoloHash<T> where
    C: HashableContent<HashType = T>, 

Asynchronously hash a reference to the given content to produce a HoloHash

Trait Implementations

impl<T> AsRef<[u8]> for HoloHash<T> where
    T: HashType, 

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

Performs the conversion.

impl AsRef<HoloHash<Agent>> for VerifySignature

pub fn as_ref(&self) -> &HoloHash<Agent>

Performs the conversion.

impl<T> Clone for HoloHash<T> where
    T: HashType + Clone, 

pub fn clone(&self) -> HoloHash<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for HoloHash<T> where
    T: HashType, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for HoloHash<T> where
    T: HashType, 

pub fn deserialize<D>(
    deserializer: D
) -> Result<HoloHash<T>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Display for HoloHash<T> where
    T: HashType, 

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

Formats the value using the given formatter.

impl<T> Eq for HoloHash<T> where
    T: HashType + Eq, 

impl From<HoloHash<Agent>> for CapGrant

pub fn from(agent_hash: HoloHash<Agent>) -> CapGrant

Performs the conversion.

impl From<HoloHash<Agent>> for HoloHash<Entry>

pub fn from(hash: HoloHash<Agent>) -> HoloHash<Entry>

Performs the conversion.

impl From<HoloHash<Agent>> for HoloHash<AnyDht>

pub fn from(hash: HoloHash<Agent>) -> HoloHash<AnyDht>

Performs the conversion.

impl From<HoloHash<AnyDht>> for HoloHash<Entry>

pub fn from(hash: HoloHash<AnyDht>) -> HoloHash<Entry>

Performs the conversion.

impl From<HoloHash<AnyDht>> for HoloHash<Header>

pub fn from(hash: HoloHash<AnyDht>) -> HoloHash<Header>

Performs the conversion.

impl From<HoloHash<Entry>> for HoloHash<Agent>

pub fn from(hash: HoloHash<Entry>) -> HoloHash<Agent>

Performs the conversion.

impl From<HoloHash<Entry>> for HoloHash<AnyDht>

pub fn from(hash: HoloHash<Entry>) -> HoloHash<AnyDht>

Performs the conversion.

impl From<HoloHash<Header>> for HoloHash<AnyDht>

pub fn from(hash: HoloHash<Header>) -> HoloHash<AnyDht>

Performs the conversion.

impl<T> From<HoloHash<T>> for HoloHashB64<T> where
    T: HashType, 

pub fn from(original: HoloHash<T>) -> HoloHashB64<T>

Performs the conversion.

impl<T> From<HoloHashB64<T>> for HoloHash<T> where
    T: HashType, 

pub fn from(original: HoloHashB64<T>) -> HoloHash<T>

Performs the conversion.

impl<T> HasHash<T> for HoloHash<T> where
    T: HashType, 

pub fn as_hash(&self) -> &HoloHash<T>

Get the hash by reference

pub fn into_hash(self) -> HoloHash<T>

Convert to the owned hash

impl<T> Hash for HoloHash<T> where
    T: HashType + Hash, 

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> IntoIterator for HoloHash<T> where
    T: HashType, 

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<<HoloHash<T> as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <HoloHash<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Ord for HoloHash<T> where
    T: HashType + Ord, 

pub fn cmp(&self, other: &HoloHash<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T> PartialEq<HoloHash<T>> for HoloHash<T> where
    T: HashType + PartialEq<T>, 

pub fn eq(&self, other: &HoloHash<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &HoloHash<T>) -> bool

This method tests for !=.

impl<T> PartialOrd<HoloHash<T>> for HoloHash<T> where
    T: HashType + PartialOrd<T>, 

pub fn partial_cmp(&self, other: &HoloHash<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for HoloHash<T> where
    T: HashType, 

pub 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<T> StructuralEq for HoloHash<T> where
    T: HashType, 

impl<T> StructuralPartialEq for HoloHash<T> where
    T: HashType, 

impl<'_, T> TryFrom<&'_ HoloHash<T>> for SerializedBytes where
    T: HashType, 

type Error = SerializedBytesError

The type returned in the event of a conversion error.

pub fn try_from(
    t: &HoloHash<T>
) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl<'_, P> TryFrom<&'_ String> for HoloHash<P> where
    P: PrimitiveHashType, 

type Error = HoloHashError

The type returned in the event of a conversion error.

pub fn try_from(s: &String) -> Result<HoloHash<P>, HoloHashError>

Performs the conversion.

impl<'_, P> TryFrom<&'_ str> for HoloHash<P> where
    P: PrimitiveHashType, 

type Error = HoloHashError

The type returned in the event of a conversion error.

pub fn try_from(s: &str) -> Result<HoloHash<P>, HoloHashError>

Performs the conversion.

impl<T> TryFrom<HoloHash<T>> for SerializedBytes where
    T: HashType, 

type Error = SerializedBytesError

The type returned in the event of a conversion error.

pub fn try_from(t: HoloHash<T>) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl<T> TryFrom<SerializedBytes> for HoloHash<T> where
    T: HashType, 

type Error = SerializedBytesError

The type returned in the event of a conversion error.

pub fn try_from(
    sb: SerializedBytes
) -> Result<HoloHash<T>, SerializedBytesError>

Performs the conversion.

impl<P> TryFrom<String> for HoloHash<P> where
    P: PrimitiveHashType, 

type Error = HoloHashError

The type returned in the event of a conversion error.

pub fn try_from(s: String) -> Result<HoloHash<P>, HoloHashError>

Performs the conversion.