Enum iprs::cid::Cid

pub enum Cid {
    Zero(Multihash),
    One(Base, Multicodec, Multihash),
}

Content Identifier.

Variants

Zero(Multihash)

Cid version ZERO. Actually this is legacy. In the distant future, we may remove this support after sha2 breaks.

One(Base, Multicodec, Multihash)

Cid version ONE.

Implementations

impl Cid

pub fn new_v0(data: &[u8]) -> Result<Cid>

Create a new Cid in Version-0 format from data. Here data shall be encoded in Multihash specification using SHA2-256 cryptographic hash algorithm.

• multibase, base58btc is implied.
• multicodec, dag-pb is implied.
• cid-version, cidv0 is implied.
• multihash is SHA2_256 computed from data.

Refer to CIDv0 spec for details

pub fn new_v1(base: Base, codec: Multicodec, data: &[u8]) -> Result<Cid>

Create a new Cid in Version-1 format from data.

cidv1 ::= multibase-prefix + multicodec-cidv1 + codec + multihash

• base, describes base-encoding to be used for this Cid.
• codec, describes multicodec-content-type of the data.
• multihash, is SHA2_256 computed from data.

Refer to CIDv1 spec for details

pub fn into_v1(self) -> Self

Transform into v1 addressing.

pub fn from_peer_id_v0(peer_id: PeerId) -> Self

Create a Cid-v0 from peer-id.

pub fn from_peer_id_v1(base: Base, peer_id: PeerId) -> Self

Create a Cid-v1 from peer-id. codec value is implied as LIBP2P_KEY.

pub fn from_text(text: &str) -> Result<Cid>

Decode a base encoded CID, human readable text. CID format can either be in legacy (v0) format or CIDv1 format.

pub fn to_base_text(&self) -> Result<String>

Encode in base format.

• If value is a CIDv0 variant, encoded into legacy base58btc format.
• If value is a CIDv1 variant, encoded using specified base format.

pub fn decode(bytes: &[u8]) -> Result<Cid>

Decode a binary encoded CID. Refer to Self::encode method for details. Supports both legacy-format and CIDv1-format.

pub fn encode(&self) -> Result<Vec<u8>>

Encode to binary format.

If value is a CIDv0 variant:

• Encoded as binary multi-hash format. The resulting bytes start with [0x12, 0x20, ...]

If value is a CIDv1 variant:

• CID-version byte
• codec, unsigned_varint multicodec value, describing multicodec-content-type or format of the data being addressed
• multihash, is SHA2-256 of data in Multihash format.

pub fn to_version(&self) -> Version

Return CID version.

pub fn to_base(&self) -> Base

Return the base encoding used for this CID.

pub fn to_content_type(&self) -> Multicodec

Return the content type or format of the data being addressed.

pub fn to_multihash(&self) -> Multihash

Return hash digest, typically encoded with SHA2-256, in which case it must be a 32-byte vector.

pub fn to_peer_id(&self) -> Option<PeerId>

If CID is pointing to a peer-id, that is if the codec is LIBP2P_KEY, return the PeerId value.

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

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

Formats the value using the given formatter.

impl Display for Cid

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

Formats the value using the given formatter.

impl Eq for Cid

impl FromStr for Cid

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Cid>

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

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