Struct cid::CidGeneric

source · [−]

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

Expand description

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<Self>

Create a new CIDv0.

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

Create a new CIDv1.

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

Create a new CID.

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: Read>(r: R) -> Result<Self>

Reads the bytes from a byte stream.

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

Writes the bytes to a byte stream.

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>

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

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

fn default() -> Self

Returns the “default value” for a type. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Performs the conversion.

impl<'a, const S: usize> From<&'a Cid<S>> for Cow<'a, Cid<S>>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a, const S: usize> From<Cid<S>> for Cow<'a, Cid<S>>

fn from(from: Cid<S>) -> Self

Performs the conversion.

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<Self>

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

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

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

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

fn cmp(&self, other: &Cid<S>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

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

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

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

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

This method tests for !=.

impl<const S: usize> PartialOrd<Cid<S>> 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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

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<Self>

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<Self>

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<Self>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self>

Performs the conversion.

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

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

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.