Struct forest_cid::Cid

pub struct Cid(_);

Implementations

impl Cid

pub fn new(version: Version, codec: u64, hash: Multihash) -> Result<Self, Error>

Create a new CID.

pub fn new_v1(codec: u64, hash: Multihash) -> Self

Create a new CIDv1.

pub fn version(&self) -> Version

Returns the cid version.

pub fn codec(&self) -> u64

Returns the cid codec.

pub fn hash(&self) -> &Multihash

Returns the cid multihash.

pub fn read_bytes<R: Read>(reader: R) -> Result<Self, Error>

Reads the bytes from a byte stream.

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

Returns the encoded bytes of the Cid.

Trait Implementations

impl Clone for Cid

pub fn clone(&self) -> Cid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Cid

impl Debug for Cid

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

Formats the value using the given formatter.

impl Default for Cid

pub fn default() -> Cid

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Cid

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

Deserialize this value from the given Serde deserializer.

impl Display for Cid

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

Formats the value using the given formatter.

impl Eq for Cid

impl From<Cid> for Prefix

pub fn from(cid: Cid) -> Self

Performs the conversion.

impl From<CidJson> for Cid

pub fn from(wrapper: CidJson) -> Self

Performs the conversion.

impl FromStr for Cid

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(src: &str) -> Result<Self, Error>

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

impl Hash for Cid

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

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

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

pub fn eq(&self, other: &Cid) -> bool

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

pub fn ne(&self, other: &Cid) -> bool

This method tests for !=.

impl PartialOrd<Cid> for Cid

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

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

pub fn lt(&self, other: &Cid) -> bool

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

pub fn le(&self, other: &Cid) -> bool

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

pub fn gt(&self, other: &Cid) -> bool

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

pub fn ge(&self, other: &Cid) -> bool

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

impl Serialize for Cid

pub fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Cid

impl StructuralPartialEq for Cid

impl<'_> TryFrom<&'_ [u8]> for Cid

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Cid

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Cid

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for Cid

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.