Enum serde_object::Object

pub enum Object<'a> {
    Bool(bool),
    I8(i8),
    I16(i16),
    I32(i32),
    I64(i64),
    I128(i128),
    U8(u8),
    U16(u16),
    U32(u32),
    U64(u64),
    U128(u128),
    F32(f32),
    F64(f64),
    Char(char),
    String(Cow<'a, str>),
    ByteArray(Cow<'a, [u8]>),
    Option(Option<Box<Object<'a>>>),
    Unit,
    UnitStruct {
        name: Cow<'a, str>,
    },
    UnitVariant {
        name: Cow<'a, str>,
        variant: Box<Object<'a>>,
    },
    NewtypeStruct {
        name: Cow<'a, str>,
        value: Box<Object<'a>>,
    },
    NewtypeVariant {
        name: Cow<'a, str>,
        variant: Box<Object<'a>>,
        value: Box<Object<'a>>,
    },
    Seq(Vec<Object<'a>>),
    Tuple(Vec<Object<'a>>),
    TupleStruct {
        name: Cow<'a, str>,
        fields: Vec<Object<'a>>,
    },
    TupleVariant {
        name: Cow<'a, str>,
        variant: Box<Object<'a>>,
        fields: Box<Object<'a>>,
    },
    Map(Vec<(Object<'a>, Object<'a>)>),
    Struct {
        name: Cow<'a, str>,
        fields: Vec<(Cow<'a, str>, Option<Object<'a>>)>,
    },
    StructVariant {
        name: Cow<'a, str>,
        variant: Box<Object<'a>>,
        fields: Box<Object<'a>>,
    },
    DualVariantKey {
        index: u32,
        name: Cow<'a, str>,
    },
    FieldMap(Vec<(Object<'a>, Option<Object<'a>>)>),
}

Represents a Serde data model value, losslessly.
See https://serde.rs/data-model.html for more information.

Limitations

• There is no way for Deserializers to hint what kind of enum variant they have available, so an assistant must be provided to support deserialising them at all.
  (Libraries can provide plug-in support here, which makes it possible to deserialize enum variants without specifying an assistant consumer-side.)

Leaks

Some memory is leaked when:

• a UnitStruct is serialized (for its name).
• a UnitVariant is serialized (for its name and variant).
• a NewtypeStruct is serialized (for its name).
• a NewtypeVariant is serialized (for its name and variant).
• a TupleStruct is serialized (for its name).
• a TupleVariant is serialized (for its name and variant).
• a Struct is serialized (for its name and each of its field keys).
• a StructVariant is deserialized (for its field keys).

TODO: Organise storage for these and add a way to clear it.

Variants

Bool(bool)

I8(i8)

I16(i16)

I32(i32)

I64(i64)

I128(i128)

U8(u8)

U16(u16)

U32(u32)

U64(u64)

U128(u128)

F32(f32)

F64(f64)

Char(char)

String(Cow<'a, str>)

ByteArray(Cow<'a, [u8]>)

Option(Option<Box<Object<'a>>>)

Unit

UnitStruct

Fields of UnitStruct

name: Cow<'a, str>

UnitVariant

Fields of UnitVariant

name: Cow<'a, str>variant: Box<Object<'a>>

NewtypeStruct

Fields of NewtypeStruct

name: Cow<'a, str>value: Box<Object<'a>>

NewtypeVariant

Fields of NewtypeVariant

name: Cow<'a, str>variant: Box<Object<'a>>value: Box<Object<'a>>

Seq(Vec<Object<'a>>)

Tuple(Vec<Object<'a>>)

TupleStruct

Fields of TupleStruct

name: Cow<'a, str>fields: Vec<Object<'a>>

TupleVariant

Fields of TupleVariant

name: Cow<'a, str>variant: Box<Object<'a>>fields: Box<Object<'a>>

Map(Vec<(Object<'a>, Object<'a>)>)

This variant does not care whether keys are duplicated.
Formats might mind it.

Struct

This variant may store duplicate fields. Formats may have a problem with it.

Fields of Struct

name: Cow<'a, str>fields: Vec<(Cow<'a, str>, Option<Object<'a>>)>

StructVariant

This variant may store duplicate fields. Formats may have a problem with it.

Fields of StructVariant

name: Cow<'a, str>variant: Box<Object<'a>>fields: Box<Object<'a>>

DualVariantKey

Created by [Serializer].
Serialized as string or u32 depending on the target ser::Serializer::is_human_readable().

Fields of DualVariantKey

index: u32name: Cow<'a, str>

FieldMap(Vec<(Object<'a>, Option<Object<'a>>)>)

Created by [Serializer] when serializing struct variants.
Like [Map], but fields may be skipped.

Implementations

impl<'a> Object<'a>

pub fn into_owned(self) -> Object<'static>

Trait Implementations

impl<'a> Debug for Object<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Object<'de>

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 Object<'de>

type Error = Error

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

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_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

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

Hint that the Deserialize type is expecting an i8 value.

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

Hint that the Deserialize type is expecting an i16 value.

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

Hint that the Deserialize type is expecting an i32 value.

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

Hint that the Deserialize type is expecting an i64 value.

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

Hint that the Deserialize type is expecting a u8 value.

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

Hint that the Deserialize type is expecting a u16 value.

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

Hint that the Deserialize type is expecting a u64 value.

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

Hint that the Deserialize type is expecting a f32 value.

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

Hint that the Deserialize type is expecting a f64 value.

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

Hint that the Deserialize type is expecting a char value.

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

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>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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_option<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

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

Hint that the Deserialize type is expecting a unit value.

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

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

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

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

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

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

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

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>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

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

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

fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

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

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

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

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

fn deserialize_i128<V>(self, visitor: V) -> Result<V::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::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

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

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

Hint that the Deserialize type is expecting a u32 value.

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

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>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

impl<'de> IntoDeserializer<'de, Error> for Object<'de>

type Deserializer = Self

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'a> Serialize for Object<'a>

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

Serialize this value into the given Serde serializer.