Struct HoloHash

pub struct HoloHash<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<AnyDhtHash>

Downcast to AnyDhtHash if this is not an external hash

pub fn into_action_hash(self) -> Option<ActionHash>

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

pub fn into_entry_hash(self) -> Option<EntryHash>

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

pub fn into_agent_pub_key(self) -> Option<AgentPubKey>

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

pub fn into_external_hash(self) -> Option<ExternalHash>

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<ActionHash>

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

pub fn into_entry_hash(self) -> Option<EntryHash>

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

pub fn into_agent_pub_key(self) -> Option<AgentPubKey>

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

impl<T: HashType> HoloHash<T>

pub fn try_from_raw_39(hash: Vec<u8>) -> HoloHashResult<Self>

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

pub fn from_raw_39(hash: Vec<u8>) -> Self

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

pub fn try_from_raw_36_and_type( bytes: Vec<u8>, hash_type: T, ) -> HoloHashResult<Self>

Use a precomputed hash + location byte array in vec form, along with a type, to construct a hash.

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

Use a precomputed hash + location byte array in vec form, along with a type, to construct a hash. Panics hash is incorrect length.

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>

consume into the inner byte vector

pub fn to_hex(&self) -> String

Get the hex representation of the hash bytes

impl<P: PrimitiveHashType> HoloHash<P>

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

Construct from 36 raw bytes, using the known PrimitiveHashType

Trait Implementations

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

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

impl From<HoloHash<Action>> for AnyDhtHash

fn from(hash: ActionHash) -> Self

Converts to this type from the input type.

impl From<HoloHash<Action>> for AnyLinkableHash

fn from(hash: ActionHash) -> Self

Converts to this type from the input type.

impl From<HoloHash<Agent>> for AnyDhtHash

fn from(hash: AgentPubKey) -> Self

Converts to this type from the input type.

impl From<HoloHash<Agent>> for AnyLinkableHash

fn from(hash: AgentPubKey) -> Self

Converts to this type from the input type.

impl From<HoloHash<Agent>> for EntryHash

fn from(hash: AgentPubKey) -> EntryHash

Converts to this type from the input type.

impl From<HoloHash<AnyDht>> for AnyLinkableHash

fn from(hash: AnyDhtHash) -> Self

Converts to this type from the input type.

impl From<HoloHash<Entry>> for AgentPubKey

fn from(hash: EntryHash) -> AgentPubKey

Converts to this type from the input type.

impl From<HoloHash<Entry>> for AnyDhtHash

fn from(hash: EntryHash) -> Self

Converts to this type from the input type.

impl From<HoloHash<Entry>> for AnyLinkableHash

fn from(hash: EntryHash) -> Self

Converts to this type from the input type.

impl From<HoloHash<External>> for AnyLinkableHash

fn from(hash: ExternalHash) -> Self

Converts to this type from the input type.

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

type HashType = T

The type of the hash which is had.

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 + HashType> Hash for HoloHash<T>

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<T: HashType> IntoIterator for HoloHash<T>

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) -> Self::IntoIter

Creates an iterator from a value.

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

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 + HashType> PartialEq for HoloHash<T>

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 + HashType> PartialOrd for HoloHash<T>

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: HashType> Serialize for HoloHash<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: HashType> TryFrom<&HoloHash<T>> for SerializedBytes

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<HoloHash<AnyDht>> for ActionHash

type Error = HashConversionError<AnyDht, Action>

The type returned in the event of a conversion error.

fn try_from(hash: AnyDhtHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyDht>> for AgentPubKey

type Error = HashConversionError<AnyDht, Agent>

The type returned in the event of a conversion error.

fn try_from(hash: AnyDhtHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyDht>> for EntryHash

type Error = HashConversionError<AnyDht, Entry>

The type returned in the event of a conversion error.

fn try_from(hash: AnyDhtHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for ActionHash

type Error = HashConversionError<AnyLinkable, Action>

The type returned in the event of a conversion error.

fn try_from(hash: AnyLinkableHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for AgentPubKey

type Error = HashConversionError<AnyLinkable, Agent>

The type returned in the event of a conversion error.

fn try_from(hash: AnyLinkableHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for AnyDhtHash

type Error = CompositeHashConversionError<AnyLinkable>

The type returned in the event of a conversion error.

fn try_from(hash: AnyLinkableHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for EntryHash

type Error = HashConversionError<AnyLinkable, Entry>

The type returned in the event of a conversion error.

fn try_from(hash: AnyLinkableHash) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHash<AnyLinkable>> for ExternalHash

type Error = HashConversionError<AnyLinkable, External>

The type returned in the event of a conversion error.

fn try_from(hash: AnyLinkableHash) -> Result<Self, Self::Error>

Performs the conversion.

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

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

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<T: Eq + HashType> Eq for HoloHash<T>

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