Struct libipld_macro::Cid

pub struct Cid { /* fields omitted */ }

Construct an Ipld from a literal.

let value = ipld!({
    "code": 200,
    "success": true,
    "payload": {
        "features": [
            "serde",
            "json"
        ]
    }
});

Variables or expressions can be interpolated into the JSON literal. Any type interpolated into an array element or object value must implement Serde's Serialize trait, while any type interpolated into a object key must implement Into<String>. If the Serialize implementation of the interpolated type decides to fail, or if the interpolated type contains a map with non-string keys, the json! macro will panic.

let code = 200;
let features = vec!["serde", "json"];

let value = ipld!({
    "code": code,
    "success": code == 200,
    "payload": {
        features[0]: features[1]
    }
});

Trailing commas are allowed inside both arrays and objects.

let value = ipld!([
    "notice",
    "the",
    "trailing",
    "comma -->",
]);

Representation of a CID.

Methods

impl Cid

Construct an Ipld from a literal.

let value = ipld!({
    "code": 200,
    "success": true,
    "payload": {
        "features": [
            "serde",
            "json"
        ]
    }
});

Variables or expressions can be interpolated into the JSON literal. Any type interpolated into an array element or object value must implement Serde's Serialize trait, while any type interpolated into a object key must implement Into<String>. If the Serialize implementation of the interpolated type decides to fail, or if the interpolated type contains a map with non-string keys, the json! macro will panic.

let code = 200;
let features = vec!["serde", "json"];

let value = ipld!({
    "code": code,
    "success": code == 200,
    "payload": {
        features[0]: features[1]
    }
});

Trailing commas are allowed inside both arrays and objects.

let value = ipld!([
    "notice",
    "the",
    "trailing",
    "comma -->",
]);

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

Create a new CIDv0.

pub fn new_v1(codec: Codec, hash: Multihash) -> Cid

Create a new CIDv1.

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

Create a new CID.

pub fn new_from_prefix(prefix: &Prefix, data: &[u8]) -> Cid

Create a new CID from a prefix and some data.

pub fn version(&self) -> Version

Returns the cid version.

pub fn codec(&self) -> Codec

Returns the cid codec.

pub fn hash(&self) -> MultihashRef

Returns the cid multihash.

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

Convert CID to encoded bytes.

pub fn prefix(&self) -> Prefix

Return the prefix of the CID.

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<'_> From<&'_ Cid> for Ipld

fn from(t: &Cid) -> Ipld

Performs the conversion.

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

fn from(cid: &Cid) -> Cid

Performs the conversion.

impl From<Cid> for Ipld

fn from(t: Cid) -> Ipld

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

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

impl Hash for Cid

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Cid

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &Cid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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

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

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