Struct Hash 

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

Hash of Entry or Operation encoded as hex string.

This uses the BLAKE3 algorithm wrapped in YASMF “Yet-Another-Smol-Multi-Format” according to the Bamboo specification.

Implementations

impl Hash

pub fn new(value: &str) -> Result<Self, HashError>

Validates and wraps encoded hash string into new Hash instance.

pub fn new_from_bytes(value: &[u8]) -> Self

Hashes byte data and returns it as Hash instance.

pub fn to_bytes(&self) -> Vec<u8>

Returns hash as bytes.

pub fn as_str(&self) -> &str

Returns hash as &str.

Trait Implementations

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hash

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl From<&Hash> for YasmfHash<ArrayVec<[u8; 32]>>

Returns Yet-Another-Smol-Multiformat Hash struct from the yasmf-hash crate.

This comes in handy when interacting with the bamboo-rs crate.

fn from(hash: &Hash) -> YasmfHash<ArrayVec<[u8; 32]>>

Converts to this type from the input type.

impl<T: Borrow<[u8]> + Clone> From<&YasmfHash<T>> for Hash

Converts YASMF hash from yasmf-hash crate to p2panda Hash instance.

fn from(yasmf_hash: &YasmfHash<T>) -> Self

Converts to this type from the input type.

impl From<Hash> for DocumentId

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl From<Hash> for DocumentViewHash

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl From<Hash> for DocumentViewId

Convenience method converting a single hash into a document view id.

Converts a Hash instance into a DocumentViewId, assuming that this document view only consists of one graph tip hash.

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl From<Hash> for OperationId

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl<T: HashId> From<T> for Hash

fn from(hash_id: T) -> Hash

Converts to this type from the input type.

impl FromStr for Hash

Convert any borrowed string representation into a Hash instance.

type Err = HashError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Hash

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

fn display(&self) -> String

Return a shortened six character representation.

Example

let hash_str = "0020cfb0fa37f36d082faad3886a9ffbcc2813b7afe90f0609a556d425f1a76ec805";
let hash: Hash = hash_str.parse().unwrap();
assert_eq!(hash.display(), "<Hash 6ec805>");

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Hash

Convert any hex-encoded string representation of a hash into a Hash instance.

type Error = HashError

The type returned in the event of a conversion error.

fn try_from(str: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Hash

Convert any owned string representation into a Hash instance.

type Error = HashError

The type returned in the event of a conversion error.

fn try_from(str: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Validate for Hash

type Error = HashError

Validation error type.

fn validate(&self) -> Result<(), Self::Error>

Validates p2panda data type instance.

impl Eq for Hash

impl StructuralPartialEq for Hash