Struct ipld_block_builder::cid::CidGeneric

pub struct CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,  { /* fields omitted */ }

Representation of a CID.

Usually you would use Cid instead, unless you have a custom Multihash code table

Implementations

impl<C, H> CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

pub fn new_v0(hash: MultihashGeneric<H>) -> Result<CidGeneric<C, H>, Error>

Create a new CIDv0.

pub fn new_v1(codec: C, hash: MultihashGeneric<H>) -> CidGeneric<C, H>

Create a new CIDv1.

pub fn new(
    version: Version,
    codec: C,
    hash: MultihashGeneric<H>
) -> Result<CidGeneric<C, H>, Error>

Create a new CID.

pub fn version(&self) -> Version

Returns the cid version.

pub fn codec(&self) -> C

Returns the cid codec.

pub fn hash(&self) -> MultihashRefGeneric<H>

Returns the cid multihash.

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

Convert CID to encoded bytes.

Trait Implementations

impl<C, H> Clone for CidGeneric<C, H> where
    C: Clone + Into<u64> + TryFrom<u64> + Copy,
    H: Clone + Into<u64> + TryFrom<u64> + Copy, 

fn clone(&self) -> CidGeneric<C, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, H> Debug for CidGeneric<C, H> where
    C: Debug + Into<u64> + TryFrom<u64> + Copy,
    H: Debug + Into<u64> + TryFrom<u64> + Copy, 

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

Formats the value using the given formatter.

impl Decode<DagCbor> for CidGeneric<Codec, Code>

fn decode<R>(r: &mut R) -> Result<CidGeneric<Codec, Code>, Error> where
    R: Read, 

Decode from an impl Read.

impl<C, H> Display for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

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

Formats the value using the given formatter.

impl Encode<DagCbor> for CidGeneric<Codec, Code>

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

Encodes into a impl Write.

impl<C, H> Eq for CidGeneric<C, H> where
    C: Eq + Into<u64> + TryFrom<u64> + Copy,
    H: Eq + Into<u64> + TryFrom<u64> + Copy, 

impl<'_, C, H> From<&'_ CidGeneric<C, H>> for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

fn from(cid: &CidGeneric<C, H>) -> CidGeneric<C, H>

Performs the conversion.

impl<'_> From<&'_ CidGeneric<Codec, Code>> for Ipld

fn from(t: &CidGeneric<Codec, Code>) -> Ipld

Performs the conversion.

impl<'a> From<&'a CidGeneric<Codec, Code>> for DagPath<'a>

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

Performs the conversion.

impl From<CidGeneric<Codec, Code>> for Ipld

fn from(t: CidGeneric<Codec, Code>) -> Ipld

Performs the conversion.

impl<C, H> FromStr for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

type Err = Error

The associated error which can be returned from parsing.

fn from_str(cid_str: &str) -> Result<CidGeneric<C, H>, Error>

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

impl<C, H> Hash for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

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

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<C, H> Ord for CidGeneric<C, H> where
    C: Ord + Into<u64> + TryFrom<u64> + Copy,
    H: Ord + Into<u64> + TryFrom<u64> + Copy, 

fn cmp(&self, other: &CidGeneric<C, H>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<C, H> PartialEq<CidGeneric<C, H>> for CidGeneric<C, H> where
    C: PartialEq<C> + Into<u64> + TryFrom<u64> + Copy,
    H: PartialEq<H> + Into<u64> + TryFrom<u64> + Copy, 

fn eq(&self, other: &CidGeneric<C, H>) -> bool

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

fn ne(&self, other: &CidGeneric<C, H>) -> bool

This method tests for !=.

impl<C, H> PartialOrd<CidGeneric<C, H>> for CidGeneric<C, H> where
    C: PartialOrd<C> + Into<u64> + TryFrom<u64> + Copy,
    H: PartialOrd<H> + Into<u64> + TryFrom<u64> + Copy, 

fn partial_cmp(&self, other: &CidGeneric<C, H>) -> Option<Ordering>

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

fn lt(&self, other: &CidGeneric<C, H>) -> bool

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

fn le(&self, other: &CidGeneric<C, H>) -> bool

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

fn gt(&self, other: &CidGeneric<C, H>) -> bool

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

fn ge(&self, other: &CidGeneric<C, H>) -> bool

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

impl<C, H> StructuralEq for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy, 

impl<C, H> StructuralPartialEq for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy, 

impl<'_, C, H> TryFrom<&'_ [u8]> for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<CidGeneric<C, H>, Error>

Performs the conversion.

impl<'_, C, H> TryFrom<&'_ str> for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cid_str: &str) -> Result<CidGeneric<C, H>, Error>

Performs the conversion.

impl<C, H> TryFrom<String> for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cid_str: String) -> Result<CidGeneric<C, H>, Error>

Performs the conversion.

impl<C, H> TryFrom<Vec<u8>> for CidGeneric<C, H> where
    C: Into<u64> + TryFrom<u64> + Copy,
    H: Into<u64> + TryFrom<u64> + Copy,
    <C as TryFrom<u64>>::Error: Debug,
    <H as TryFrom<u64>>::Error: Debug, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<CidGeneric<C, H>, Error>

Performs the conversion.

impl TryReadCbor for CidGeneric<Codec, Code>

fn try_read_cbor<R>(
    r: &mut R,
    major: u8
) -> Result<Option<CidGeneric<Codec, Code>>, Error> where
    R: Read,