Struct Cid 

pub struct Cid { /* private fields */ }

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: RawMultihash) -> Result<Cid, Error>

Create a new CIDv0.

pub fn new_v1(codec: u64, hash: RawMultihash) -> Cid

Create a new CIDv1.

pub fn new( version: Version, codec: u64, hash: RawMultihash, ) -> Result<Cid, 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) -> &RawMultihash

Returns the cid multihash.

pub fn read_bytes<R>(r: R) -> Result<Cid, 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>

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

let mh = Multihash::new(SHA2_256, b"foo").unwrap();
let cid = Cid::new_v1(RAW, mh.to_raw().unwrap());
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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cid

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

Formats the value using the given formatter.

impl Decode<DagCborCodec> for Cid

fn decode<R>(_: DagCborCodec, r: &mut R) -> Result<Cid, Error>

where R: Read,

Decode from an impl Read.

impl Default for Cid

fn default() -> Cid

Returns the “default value” for a type.

impl Display for Cid

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

Formats the value using the given formatter.

impl Encode<DagCborCodec> for Cid

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

where W: Write,

Encodes into a impl Write.

impl From<&Cid> for Cid

fn from(cid: &Cid) -> Cid

Converts to this type from the input type.

impl From<Cid> for Vec<u8>

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

Converts to this type from the input type.

impl FromStr for Cid

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Cid

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Cid

fn eq(&self, other: &Cid) -> 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 TryFrom<&[u8]> for Cid

type Error = Error

The type returned in the event of a conversion error.

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

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<Cid, Error>

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<Cid, Error>

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<Cid, Error>

Performs the conversion.

impl TryReadCbor for Cid

fn try_read_cbor<R>(r: &mut R, major: u8) -> Result<Option<Cid>, Error>

where R: Read,

Takes the read major code and tries to parse from a byte stream. If parsing fails the byte stream must not be advanced.

impl Copy for Cid

impl Eq for Cid

impl StructuralPartialEq for Cid