Enum forest_ipld::Ipld

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

Represents IPLD data structure used when serializing and deserializing data.

Variants

Null

Represents a null value.

let v = ipld!(null);

Bool(bool)

Represents a boolean value.

let v = ipld!(true);

Integer(i128)

Represents a signed integer value.

let v = ipld!(28);

Float(f64)

Represents a floating point value.

let v = ipld!(8.5);

String(String)

Represents a String.

let v = ipld!("string");

Bytes(Vec<u8>)

Represents Bytes.

let v = ipld!(Bytes(vec![0x98, 0x8, 0x2a, 0xff]));

List(Vec<Ipld>)

Represents List of IPLD objects.

let v = ipld!([1, "string", null]);

Map(BTreeMap<String, Ipld>)

Represents a map of strings to Ipld objects.

let v = ipld!({"key": "value", "bool": true});

Link(Cid)

Represents a link to another piece of data through a content identifier (Cid). Using ipld macro, can wrap Cid with Link to be explicit of Link type, or let it resolve.

let cid: Cid = "QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n".parse().unwrap();
let v1 = ipld!(Link(cid.clone()));
let v2 = ipld!(cid);
assert_eq!(v1, v2);

Trait Implementations

impl Cbor for Ipld

pub fn marshal_cbor(&self) -> Result<Vec<u8, Global>, Error>

Marshalls cbor encodable object into cbor bytes

pub fn unmarshal_cbor(bz: &[u8]) -> Result<Self, Error>

Unmarshals cbor encoded bytes to object

pub fn cid(&self) -> Result<Cid, Error>

Returns the content identifier of the raw block of data Default is Blake2b256 hash

impl Clone for Ipld

pub fn clone(&self) -> Ipld

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipld

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ipld

pub fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Ipld> for Ipld

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

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

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

This method tests for !=.

impl Serialize for Ipld

pub fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Ipld