Struct HoloHash

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

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 HoloHash<AnyLinkable>

pub fn into_primitive(self) -> AnyLinkableHashPrimitive

Match on the primitive hash type represented by this composite hash type

pub fn into_any_dht_hash(self) -> Option<HoloHash<AnyDht>>

Downcast to AnyDhtHash if this is not an external hash

pub fn into_action_hash(self) -> Option<HoloHash<Action>>

If this hash represents an ActionHash, return it, else None

pub fn into_entry_hash(self) -> Option<HoloHash<Entry>>

If this hash represents an EntryHash, return it, else None

pub fn into_agent_pub_key(self) -> Option<HoloHash<Agent>>

If this hash represents an EntryHash which is actually an AgentPubKey, return it, else None.

pub fn into_external_hash(self) -> Option<HoloHash<External>>

If this hash represents an ExternalHash, return it, else None

impl HoloHash<AnyDht>

pub fn into_primitive(self) -> AnyDhtHashPrimitive

Match on the primitive hash type represented by this composite hash type

pub fn into_action_hash(self) -> Option<HoloHash<Action>>

If this hash represents an ActionHash, return it, else None

pub fn into_entry_hash(self) -> Option<HoloHash<Entry>>

If this hash represents an EntryHash, return it, else None

pub fn into_agent_pub_key(self) -> Option<HoloHash<Agent>>

If this hash represents an EntryHash which is actually an AgentPubKey, return it, else None.

impl<T> HoloHash<T>

where T: HashType,

pub fn from_raw_39(hash: Vec<u8>) -> 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>) -> 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>, 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 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) -> DhtLocation

Fetch the holo dht location for this hash

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

consume into the inner byte vector

pub fn to_hex(&self) -> String

Get the hex representation of the hash bytes

impl<T> HoloHash<T>

where T: HashType,

pub fn from_raw_32_and_type(hash: Vec<u8>, 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.

impl<P> HoloHash<P>

where P: PrimitiveHashType,

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

Construct from 36 raw bytes, using the known PrimitiveHashType

pub fn from_raw_32(hash: Vec<u8>) -> 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 AnyDhtHashTransformer for HoloHash<AnyDht>

fn try_from_string(input: &str) -> Result<HoloHash<AnyDht>, WasmError>

Automatically determine correct type from a string

impl AnyLinkableHashTransformer for HoloHash<AnyLinkable>

fn try_from_string(input: &str) -> Result<HoloHash<AnyLinkable>, WasmError>

Automatically determine correct type from a string

fn must_be_action_hash(&self) -> Result<HoloHash<Action>, WasmError>

Expect hash type to be an ActionHash or error

fn must_be_entry_hash(&self) -> Result<HoloHash<Entry>, WasmError>

Expect hash type to be an EntryHash or error

impl<'a> Arbitrary<'a> for HoloHash<AnyLinkable>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<HoloHash<AnyLinkable>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<'a, P> Arbitrary<'a> for HoloHash<P>

where P: PrimitiveHashType,

fn arbitrary(u: &mut Unstructured<'a>) -> Result<HoloHash<P>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<T> AsRef<[u8]> for HoloHash<T>

where T: HashType,

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

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

impl AsRef<HoloHash<Agent>> for VerifySignature

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

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

impl<T> AsRef<HoloHash<T>> for HoloHashB64<T>

where T: HashType,

fn as_ref(&self) -> &HoloHash<T>

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

impl<T> Clone for HoloHash<T>

where T: Clone + HashType,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for HoloHash<T>

where T: HashType,

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,

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,

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

Formats the value using the given formatter.

impl From<HoloHash<Action>> for DeleteInput

fn from(deletes_action_hash: HoloHash<Action>) -> DeleteInput

Sets ChainTopOrdering to default = Strict when created from a hash.

impl From<HoloHash<Action>> for HoloHash<AnyDht>

fn from(hash: HoloHash<Action>) -> HoloHash<AnyDht>

Converts to this type from the input type.

impl From<HoloHash<Action>> for HoloHash<AnyLinkable>

fn from(hash: HoloHash<Action>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

impl From<HoloHash<Agent>> for Authority

fn from(agent_pub_key: HoloHash<Agent>) -> Authority

Converts to this type from the input type.

impl From<HoloHash<Agent>> for CapGrant

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<HoloHash<Agent>> for HoloHash<AnyLinkable>

fn from(hash: HoloHash<Agent>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<HoloHash<AnyDht>> for HoloHash<AnyLinkable>

fn from(hash: HoloHash<AnyDht>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<HoloHash<Entry>> for HoloHash<AnyLinkable>

fn from(hash: HoloHash<Entry>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

impl From<HoloHash<External>> for HoloHash<AnyLinkable>

fn from(hash: HoloHash<External>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

impl<T> From<HoloHash<T>> for HoloHashB64<T>

where T: HashType,

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

Converts to this type from the input type.

impl From<HoloHashB64<Action>> for HoloHash<AnyDht>

fn from(h: HoloHashB64<Action>) -> HoloHash<AnyDht>

Converts to this type from the input type.

impl From<HoloHashB64<Action>> for HoloHash<AnyLinkable>

fn from(h: HoloHashB64<Action>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

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

fn from(h: HoloHashB64<Entry>) -> HoloHash<AnyDht>

Converts to this type from the input type.

impl From<HoloHashB64<Entry>> for HoloHash<AnyLinkable>

fn from(h: HoloHashB64<Entry>) -> HoloHash<AnyLinkable>

Converts to this type from the input type.

impl<T> From<HoloHashB64<T>> for HoloHash<T>

where T: HashType,

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

Converts to this type from the input type.

impl<T> HasHash<T> for HoloHash<T>

where T: HashType,

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

Get the hash by reference

fn into_hash(self) -> HoloHash<T>

Convert to the owned hash

impl<T> Hash for HoloHash<T>

where T: Hash + HashType,

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 Into<GetEntityInput> for HoloHash<Action>

fn into(self) -> GetEntityInput

Converts this type into the (usually inferred) input type.

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>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<T> Ord for HoloHash<T>

where T: Ord + HashType,

fn cmp(&self, other: &HoloHash<T>) -> 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<T> PartialEq for HoloHash<T>

where T: PartialEq + HashType,

fn eq(&self, other: &HoloHash<T>) -> 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<T> PartialOrd for HoloHash<T>

where T: PartialOrd + HashType,

fn partial_cmp(&self, other: &HoloHash<T>) -> 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<T> Serialize for HoloHash<T>

where T: HashType,

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> TryFrom<&HoloHash<T>> for SerializedBytes

where T: HashType,

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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.

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.

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

Performs the conversion.

impl TryFrom<HoloHash<AnyDht>> for HoloHash<Action>

type Error = HashConversionError<AnyDht, Action>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyDht>, ) -> Result<HoloHash<Action>, <HoloHash<Action> as TryFrom<HoloHash<AnyDht>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyDht>> for HoloHash<Agent>

type Error = HashConversionError<AnyDht, Agent>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyDht>, ) -> Result<HoloHash<Agent>, <HoloHash<Agent> as TryFrom<HoloHash<AnyDht>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyDht>> for HoloHash<Entry>

type Error = HashConversionError<AnyDht, Entry>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyDht>, ) -> Result<HoloHash<Entry>, <HoloHash<Entry> as TryFrom<HoloHash<AnyDht>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for HoloHash<Action>

type Error = HashConversionError<AnyLinkable, Action>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyLinkable>, ) -> Result<HoloHash<Action>, <HoloHash<Action> as TryFrom<HoloHash<AnyLinkable>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for HoloHash<Agent>

type Error = HashConversionError<AnyLinkable, Agent>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyLinkable>, ) -> Result<HoloHash<Agent>, <HoloHash<Agent> as TryFrom<HoloHash<AnyLinkable>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for HoloHash<AnyDht>

type Error = CompositeHashConversionError<AnyLinkable>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyLinkable>, ) -> Result<HoloHash<AnyDht>, <HoloHash<AnyDht> as TryFrom<HoloHash<AnyLinkable>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for HoloHash<Entry>

type Error = HashConversionError<AnyLinkable, Entry>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyLinkable>, ) -> Result<HoloHash<Entry>, <HoloHash<Entry> as TryFrom<HoloHash<AnyLinkable>>>::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for HoloHash<External>

type Error = HashConversionError<AnyLinkable, External>

The type returned in the event of a conversion error.

fn try_from( hash: HoloHash<AnyLinkable>, ) -> Result<HoloHash<External>, <HoloHash<External> as TryFrom<HoloHash<AnyLinkable>>>::Error>

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.

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

Performs the conversion.

impl TryFrom<PathInput> for HoloHash<AnyLinkable>

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(input: PathInput) -> Result<HoloHash<AnyLinkable>, WasmError>

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.

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.

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

Performs the conversion.

impl<T> Eq for HoloHash<T>

where T: Eq + HashType,

impl<T> StructuralPartialEq for HoloHash<T>

where T: HashType,