Struct tiny_cid::Cid

pub struct Cid { /* fields omitted */ }

Representation of a CID.

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

Implementations

impl Cid

pub fn new_v0(hash: Multihash<U64>) -> Result<Self>

Create a new CIDv0.

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

Create a new CIDv1.

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

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

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 tiny_cid::{RAW, Cid};
use multibase::Base;
use tiny_multihash::{Code, MultihashCode};

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

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 Copy for Cid

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 Display for Cid

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

Formats the value using the given formatter.

impl Eq for Cid

impl<'_> From<&'_ Cid> for Cid

fn from(cid: &Cid) -> Self

Performs the conversion.

impl<'a> From<&'a Cid> for Cow<'a, Cid>

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

Performs the conversion.

impl From<Cid> for Vec<u8>

fn from(cid: Cid) -> Self

Performs the conversion.

impl From<Cid> for String

fn from(cid: Cid) -> Self

Performs the conversion.

impl<'a> From<Cid> for Cow<'a, Cid>

fn from(from: Cid) -> Self

Performs the conversion.

impl FromStr for Cid

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.

impl Hash for Cid

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

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 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(bytes: &[u8]) -> Result<Self>

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Cid

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 TryFrom<String> for Cid

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 TryFrom<Vec<u8>> for Cid

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.