Struct forest_cid::Cid

pub struct Cid {
    pub version: Version,
    pub codec: Codec,
    pub hash: Multihash,
}

Representation of a IPLD CID.

Fields

version: Version

codec: Codec

hash: Multihash

Implementations

impl Cid

pub fn new(codec: Codec, version: Version, hash: Multihash) -> Cid

Create a new CID.

pub fn new_v1(codec: Codec, hash: Multihash) -> Cid

Create a new v1 CID.

pub fn new_v0(codec: Codec, hash: Multihash) -> Cid

Create a new v0 CID.

pub fn new_from_cbor<T: MultihashDigest>(bz: &[u8], hash: T) -> Self

Constructs a cid with bytes using default version and codec

pub fn from_raw_cid<T: TryInto<Cid>>(data: T) -> Result<Cid, T::Error>

Create a new CID from raw data (binary or multibase encoded string)

pub fn new_from_prefix(prefix: &Prefix, data: &[u8]) -> Result<Cid, Error>

Create a new CID from a prefix and some data.

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

Returns encoded bytes of a cid

pub fn prefix(&self) -> Prefix

Returns prefix for Cid format

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

Returns cid in bytes to be stored in datastore

Trait Implementations

impl Clone for Cid

fn clone(&self) -> Cid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cid

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

Formats the value using the given formatter.

impl Default for Cid

fn default() -> Self

Returns the "default value" for a type.

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

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

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

Formats the value using the given formatter.

impl Eq for Cid

impl FromStr for Cid

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Cid

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Cid> for Cid

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

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

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

This method tests for !=.

impl Serialize for Cid

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.

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.

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.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for Cid

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.