Struct CidGeneric 

pub struct CidGeneric<const S: usize> { /* private fields */ }

Representation of a CID.

The generic is about the allocated size of the multihash.

Implementations

impl<const S: usize> Cid<S>

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

Create a new CIDv0.

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

Create a new CIDv1.

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

Create a new CID.

pub fn into_v1(self) -> Result<Cid<S>, Error>

Convert a CIDv0 to a CIDv1. Returns unchanged if already a CIDv1.

pub const fn version(&self) -> Version

Returns the cid version.

pub const fn codec(&self) -> u64

Returns the cid codec.

pub const 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<usize, Error>

where W: Write,

Writes the bytes to a byte stream, returns the number of bytes written.

pub fn encoded_len(&self) -> usize

Returns the length in bytes needed to encode this cid into bytes.

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

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_codetable::{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<const S: usize> Clone for Cid<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const S: usize> Debug for Cid<S>

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

Formats the value using the given formatter.

impl<const S: usize> Default for Cid<S>

fn default() -> Cid<S>

Returns the “default value” for a type.

impl<'de, const SIZE: usize> Deserialize<'de> for Cid<SIZE>

Deserialize a CID into a newtype struct.

Deserialize a CID that was serialized as a newtype struct, so that can be identified as a CID. Its corresponding Rust type would be:

struct $__private__serde__identifier__for__cid(serde_bytes::BytesBuf);

fn deserialize<D>( deserializer: D, ) -> Result<Cid<SIZE>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const S: usize> Display for Cid<S>

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

Formats the value using the given formatter.

impl From<&Cid<64>> for Ipld

fn from(t: &Cid<64>) -> Ipld

Converts to this type from the input type.

impl<const S: usize> From<&Cid<S>> for Cid<S>

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

Converts to this type from the input type.

impl From<Cid<64>> for Ipld

fn from(t: Cid<64>) -> Ipld

Converts to this type from the input type.

impl<const S: usize> From<Cid<S>> for Vec<u8>

fn from(cid: Cid<S>) -> Vec<u8>

Converts to this type from the input type.

impl<const S: usize> FromStr for Cid<S>

type Err = Error

The associated error which can be returned from parsing.

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

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

impl<const S: usize> Hash for Cid<S>

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

where __H: Hasher,

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<const S: usize> Ord for Cid<S>

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

fn eq(&self, other: &Cid<S>) -> 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<const S: usize> PartialOrd for Cid<S>

fn partial_cmp(&self, other: &Cid<S>) -> 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<const SIZE: usize> Serialize for Cid<SIZE>

Serialize a CID into the Serde data model as enum.

Custom types are not supported by Serde, hence we map a CID into an enum that can be identified as a CID by implementations that support CIDs. The corresponding Rust type would be:

struct $__private__serde__identifier__for__cid(serde_bytes::BytesBuf);

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const S: usize> TryFrom<&[u8]> for Cid<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const S: usize> TryFrom<&str> for Cid<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipld> for Cid<64>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Cid<64>, <Cid<64> as TryFrom<Ipld>>::Error>

Performs the conversion.

impl<const S: usize> TryFrom<String> for Cid<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const S: usize> TryFrom<Vec<u8>> for Cid<S>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const S: usize> Copy for Cid<S>

impl<const S: usize> Eq for Cid<S>

impl<const S: usize> StructuralPartialEq for Cid<S>