Enum 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),
}

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

Represents a sequence of bytes.

List(Vec<Ipld>)

Represents a list.

Map(BTreeMap<String, Ipld>)

Represents a map of strings.

Link(Cid)

Represents a map of integers.

Implementations

impl Ipld

pub fn kind(&self) -> IpldKind

Convert from an Ipld object into its kind without any associated values.

This is intentionally not implemented via From<Ipld> to prevent accidental conversions by making it more explicit.

pub fn take<'a, T: Into<IpldIndex<'a>>>( self, index: T, ) -> Result<Option<Self>, IndexError>

Destructs an ipld list or map

pub fn get<'a, T: Into<IpldIndex<'a>>>( &self, index: T, ) -> Result<Option<&Self>, IndexError>

Indexes into an ipld list or map.

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

Returns an iterator.

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

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for Ipld

Deserialize from an Ipld enum into a Rust type.

The deserialization will return an error if you try to deserialize into an integer type that would be too small to hold the value stored in Ipld::Integer.

[Ipld::Floats] can be converted to f32 if there is no of precision, else it will error.

type Error = SerdeError

The error type that can be returned if some error occurs during deserialization.

fn deserialize_i8<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_unit<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a unit value.

fn deserialize_bool<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a bool value.

fn deserialize_f32<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_seq<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V: Visitor<'de>>( self, len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V: Visitor<'de>>( self, _name: &str, len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_identifier<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_struct<V: Visitor<'de>>( self, _name: &str, _fields: &[&str], visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_unit_struct<V: Visitor<'de>>( self, _name: &str, _visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_newtype_struct<V: Visitor<'de>>( self, name: &str, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_enum<V: Visitor<'de>>( self, _name: &str, _variants: &[&str], visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_ignored_any<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_option<V: Visitor<'de>>( self, visitor: V, ) -> Result<V::Value, Self::Error>

Hint that the Deserialize type is expecting an optional value.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

impl From<&[u8]> for Ipld

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

Converts to this type from the input type.

impl From<&Cid<64>> for Ipld

fn from(t: &Cid) -> Self

Converts to this type from the input type.

impl From<&str> for Ipld

fn from(t: &str) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(t: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<Cid<64>> for Ipld

fn from(t: Cid) -> Self

Converts to this type from the input type.

impl From<String> for Ipld

fn from(t: String) -> Self

Converts to this type from the input type.

impl From<Vec<Ipld>> for Ipld

fn from(t: Vec<Ipld>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Ipld

fn from(t: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Ipld

fn from(t: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Ipld

fn from(t: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Ipld

fn from(t: f64) -> Self

Converts to this type from the input type.

impl From<i128> for Ipld

fn from(t: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Ipld

fn from(t: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Ipld

fn from(t: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Ipld

fn from(t: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Ipld

fn from(t: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Ipld

fn from(t: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Ipld

fn from(t: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Ipld

fn from(t: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Ipld

fn from(t: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Ipld

fn from(t: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Ipld

fn from(t: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Ipld

NaN floats are forbidden in the IPLD Data Model, but we do not enforce it. So in case such a value is introduced accidentally, make sure that it still compares as equal. This allows us to implement Eq for Ipld.

fn eq(&self, other: &Self) -> 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 Serialize for Ipld

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Ipld> for ()

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Cid

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<BTreeMap<String, Ipld>>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<Cid>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<String>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<Vec<Ipld>>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<Vec<u8>>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<bool>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<f64>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<i128>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<i16>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<i32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<i64>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<i8>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<isize>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<u128>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<u16>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<u64>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<u8>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Option<usize>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for String

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Vec<Ipld>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for Vec<u8>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for bool

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for f64

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for i128

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for i16

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for i32

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for i64

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for i8

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for isize

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for u128

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for u16

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for u32

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for u64

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for u8

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Ipld> for usize

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Ipld