Struct libipld::cid::CidGeneric

pub struct CidGeneric<S> where
    S: Size,  { /* fields omitted */ }

Representation of a CID.

The generic is about the allocated size of the multihash.

Implementations

impl<S> Cid<S> where
    S: Size, 

pub fn new_v0(hash: Multihash<S>) -> Result<Cid<S>, Error>

Create a new CIDv0.

pub fn new_v1(codec: u64, hash: Multihash<S>) -> Cid<S>

Create a new CIDv1.

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

Create a new CID.

pub fn version(&self) -> Version

Returns the cid version.

pub fn codec(&self) -> u64

Returns the cid codec.

pub fn hash(&self) -> &Multihash<S>

Returns the cid multihash.

pub fn read_bytes<R>(r: R) -> Result<Cid<S>, Error> where
    R: Read, 

Reads the bytes from a byte stream.

pub fn write_bytes<W>(&self, w: W) -> Result<(), Error> where
    W: Write, 

Writes the bytes to a byte stream.

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

Returns the encoded bytes of the Cid.

pub fn to_string_of_base(&self, base: Base) -> Result<String, Error>

Convert CID into a multibase encoded string

Example

use cid::Cid;
use multibase::Base;
use multihash::{Code, MultihashDigest};

const RAW: u64 = 0x55;

let cid = Cid::new_v1(RAW, Code::Sha2_256.digest(b"foo"));
let encoded = cid.to_string_of_base(Base::Base64).unwrap();
assert_eq!(encoded, "mAVUSICwmtGto/8aP+ZtFPB0wQTQTQi1wZIO/oPmKXohiZueu");

Trait Implementations

impl<T> AsRef<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Link<T>

pub fn as_ref(
    &self
) -> &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

Performs the conversion.

impl<S> AsRef<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

fn as_ref(&self) -> &Cid

Performs the conversion.

impl<S> Borrow<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Block<S>

fn borrow(&self) -> &Cid

Immutably borrows from an owned value.

impl<S> Clone for Cid<S> where
    S: Clone + Size, 

pub fn clone(&self) -> Cid<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Copy for Cid<S> where
    S: Size,
    <S as ArrayLength<u8>>::ArrayType: Copy, 

impl<S> Debug for Cid<S> where
    S: Size, 

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

Formats the value using the given formatter.

impl Decode<DagCborCodec> for Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

pub fn decode<R>(
    DagCborCodec,
    r: &mut R
) -> Result<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>, Error> where
    R: Read + Seek, 

Decode from an impl Read.

impl<S> Default for Cid<S> where
    S: Size, 

pub fn default() -> Cid<S>

Returns the "default value" for a type.

impl<S> Display for Cid<S> where
    S: Size, 

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

Formats the value using the given formatter.

impl Encode<DagCborCodec> for Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

pub fn encode<W>(&self, DagCborCodec, w: &mut W) -> Result<(), Error> where
    W: Write, 

Encodes into a impl Write.

impl<S> Eq for Cid<S> where
    S: Eq + Size, 

impl<'_, S> From<&'_ Cid<S>> for Cid<S> where
    S: Size,
    <S as ArrayLength<u8>>::ArrayType: Copy, 

pub fn from(cid: &Cid<S>) -> Cid<S>

Performs the conversion.

impl<'_> From<&'_ Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Ipld

pub fn from(
    t: &Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Ipld

Performs the conversion.

impl<'a> From<&'a Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for DagPath<'a>

fn from(cid: &'a Cid) -> Self

Performs the conversion.

impl<T> From<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Link<T>

pub fn from(
    cid: Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Link<T>

Performs the conversion.

impl From<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Ipld

pub fn from(
    t: Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Ipld

Performs the conversion.

impl<S> FromStr for Cid<S> where
    S: Size, 

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(cid_str: &str) -> Result<Cid<S>, Error>

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

impl<S> Hash for Cid<S> where
    S: Hash + Size, 

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

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<S> Ord for Cid<S> where
    S: Ord + Size, 

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

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

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

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

This method tests for !=.

impl<S> PartialOrd<Cid<S>> for Cid<S> where
    S: PartialOrd<S> + Size, 

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<S> StructuralEq for Cid<S> where
    S: Size, 

impl<S> StructuralPartialEq for Cid<S> where
    S: Size, 

impl<'_, S> TryFrom<&'_ [u8]> for Cid<S> where
    S: Size, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(bytes: &[u8]) -> Result<Cid<S>, Error>

Performs the conversion.

impl<'_, S> TryFrom<&'_ str> for Cid<S> where
    S: Size, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(cid_str: &str) -> Result<Cid<S>, Error>

Performs the conversion.

impl<S> TryFrom<String> for Cid<S> where
    S: Size, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(cid_str: String) -> Result<Cid<S>, Error>

Performs the conversion.

impl<S> TryFrom<Vec<u8, Global>> for Cid<S> where
    S: Size, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(bytes: Vec<u8, Global>) -> Result<Cid<S>, Error>

Performs the conversion.