Struct Object 

pub struct Object<T> {
    pub class: Option<Global>,
    pub form: Option<Form>,
    pub value: T,
}

A value with the class of a Python object.

When deserialized the class of the value (if there is one) is captured, when serialized the value is written as an object of the class:

use std::collections::BTreeMap;
use deser_pickle::{Global, Object};

// a `Point(x=1, y=2)` of a module `geometry`
let input = b"\x80\x04\x95*\x00\x00\x00\x00\x00\x00\x00\x8c\x08geometry\x94\x8c\x05Point\x94\x93\x94)\x81\x94}\x94(\x8c\x01x\x94K\x01\x8c\x01y\x94K\x02ub.";
let point: Object<BTreeMap<String, i32>> = deser_pickle::from_slice(input).unwrap();
assert_eq!(point.class, Some(Global::new("geometry", "Point")));
assert_eq!(point.value["y"], 2);

Other formats do not have classes. When deserializing from such formats, the class is None, when serializing it’s ignored.

Fields

class: Option<Global>

The class of the value.

form: Option<Form>

How the object is created from the value (see Form).

value: T

The value.

Implementations

impl<T> Object<T>

pub fn new(class: Global, value: T) -> Object<T>

Creates a value with a class.

pub fn with_form(class: Global, form: Form, value: T) -> Object<T>

Creates a value with a class and the form the object is created in.

pub fn into_inner(self) -> T

Returns the inner value.

Trait Implementations

impl<T: Clone> Clone for Object<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Object<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Object<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Object<T>

fn deserialize_into<'out>( out: &'out mut Option<Self>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<T: Eq> Eq for Object<T>

impl<T: Hash> Hash for Object<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Object<T>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for Object<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Object<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Serialize> Serialize for Object<T>

fn serialize<'a>(this: &'a Self, state: &mut State) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(this: &Self, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(this: &Self) -> bool

Checks if the value represents an optional value.

fn container_shape(this: &Self) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

fn describe(this: &Self, d: &mut dyn Describe)

Describes the Rust shape of the value.

impl<T: PartialEq> StructuralPartialEq for Object<T>