Enum libipld_macro::Ipld

pub enum Ipld {
    Null,
    Bool(bool),
    Integer(i128),
    Float(f64),
    String(String),
    Bytes(Vec<u8, Global>),
    List(Vec<Ipld, Global>),
    Map(BTreeMap<String, Ipld>),
    Link(Cid<64_usize>),
}

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 -->",
]);

Ipld

Variants

Null

Represents the absence of a value or the value undefined.

Bool(bool)

Represents a boolean value.

Integer(i128)

Represents an integer.

Float(f64)

Represents a floating point value.

String(String)

Represents an UTF-8 string.

Bytes(Vec<u8, Global>)

Represents a sequence of bytes.

List(Vec<Ipld, Global>)

Represents a list.

Map(BTreeMap<String, Ipld>)

Represents a map of strings.

Link(Cid<64_usize>)

Represents a map of integers.

Implementations

impl Ipld

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 take<'a, T>(self, index: T) -> Result<Ipld, TypeError> where
    T: Into<IpldIndex<'a>>, 

Destructs an ipld list or map

pub fn get<'a, T>(&self, index: T) -> Result<&Ipld, TypeError> where
    T: Into<IpldIndex<'a>>, 

Indexes into an ipld list or map.

pub fn iter(&self) -> IpldIter<'_>

Returns an iterator.

pub fn references<E>(&self, set: &mut E) where
    E: Extend<Cid<64_usize>>, 

Returns the references to other blocks.

Trait Implementations

impl Clone for Ipld

fn clone(&self) -> Ipld

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipld

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

Formats the value using the given formatter.

impl Decode<RawCodec> for Ipld

fn decode<R>(c: RawCodec, r: &mut R) -> Result<Ipld, Error> where
    R: Read + Seek, 

Decode from an impl Read.

impl Encode<RawCodec> for Ipld

fn encode<W>(&self, c: RawCodec, w: &mut W) -> Result<(), Error> where
    W: Write, 

Encodes into a impl Write.

impl<'_> From<&'_ [u8]> for Ipld

fn from(t: &[u8]) -> Ipld

Performs the conversion.

impl<'_> From<&'_ Cid<64_usize>> for Ipld

fn from(t: &Cid<64_usize>) -> Ipld

Performs the conversion.

impl<'_> From<&'_ str> for Ipld

fn from(t: &str) -> Ipld

Performs the conversion.

impl From<BTreeMap<String, Ipld>> for Ipld

fn from(t: BTreeMap<String, Ipld>) -> Ipld

Performs the conversion.

impl From<Box<[u8], Global>> for Ipld

fn from(t: Box<[u8], Global>) -> Ipld

Performs the conversion.

impl From<Cid<64_usize>> for Ipld

fn from(t: Cid<64_usize>) -> Ipld

Performs the conversion.

impl From<String> for Ipld

fn from(t: String) -> Ipld

Performs the conversion.

impl From<Vec<Ipld, Global>> for Ipld

fn from(t: Vec<Ipld, Global>) -> Ipld

Performs the conversion.

impl From<Vec<u8, Global>> for Ipld

fn from(t: Vec<u8, Global>) -> Ipld

Performs the conversion.

impl From<bool> for Ipld

fn from(t: bool) -> Ipld

Performs the conversion.

impl From<f32> for Ipld

fn from(t: f32) -> Ipld

Performs the conversion.

impl From<f64> for Ipld

fn from(t: f64) -> Ipld

Performs the conversion.

impl From<i128> for Ipld

fn from(t: i128) -> Ipld

Performs the conversion.

impl From<i16> for Ipld

fn from(t: i16) -> Ipld

Performs the conversion.

impl From<i32> for Ipld

fn from(t: i32) -> Ipld

Performs the conversion.

impl From<i64> for Ipld

fn from(t: i64) -> Ipld

Performs the conversion.

impl From<i8> for Ipld

fn from(t: i8) -> Ipld

Performs the conversion.

impl From<isize> for Ipld

fn from(t: isize) -> Ipld

Performs the conversion.

impl From<u16> for Ipld

fn from(t: u16) -> Ipld

Performs the conversion.

impl From<u32> for Ipld

fn from(t: u32) -> Ipld

Performs the conversion.

impl From<u64> for Ipld

fn from(t: u64) -> Ipld

Performs the conversion.

impl From<u8> for Ipld

fn from(t: u8) -> Ipld

Performs the conversion.

impl From<usize> for Ipld

fn from(t: usize) -> Ipld

Performs the conversion.

impl PartialEq<Ipld> for Ipld

fn eq(&self, other: &Ipld) -> bool

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

fn ne(&self, other: &Ipld) -> bool

This method tests for !=.

impl StructuralPartialEq for Ipld