Trait Serialize

Source

pub trait Serialize<T: ?Sized = Self>: Sync {
    // Required method
    fn serialize<'a>(value: &'a T, state: &mut State) -> Result<Emit<'a>, Error>;

    // Provided methods
    fn finish(value: &T, state: &mut State) -> Result<(), Error> { ... }
    fn is_optional(value: &T) -> bool { ... }
    fn describe(value: &T, d: &mut dyn Describe) { ... }
    fn container_shape(value: &T) -> ContainerShape { ... }
}

Expand description

A data structure that can be serialized into any data format supported by Deser.

serialize serializes the value into an Emit. For compound values like lists or structs, it holds an emitter which hands out the values the compound value contains. The container_shape of such values is passed on with the start event of the container.

§Adapters

The type parameter T is the type of the value that is serialized. It defaults to Self: impl Serialize for Foo serializes Foo values. A type that implements Serialize for another type is an adapter, it serializes values of that type on their behalf (see adapters):

use deser::ser::{Emit, Serialize};
use deser::{Atom, Error, State};

/// Serializes a `u32` as string.
pub struct AsString;

impl Serialize<u32> for AsString {
    fn serialize<'a>(value: &'a u32, _state: &mut State) -> Result<Emit<'a>, Error> {
        Ok(Emit::Atom(Atom::Str(value.to_string().into())))
    }
}

Adapters are never instantiated, only their functions are used. The serializers of the data formats receive the values as SerializeRef, a reference to the value with its type (and adapter) erased.

§Thread Safety

Serializables are Sync and the emitters they create are Send. This allows an ongoing serialization (a SerializeDriver) to move between threads, for instance when it is suspended while the output is written asynchronously. Types with shared ownership or interior mutability that is not thread safe (such as Rc or RefCell) cannot be serialized. Mutex and RwLock cannot be serialized either as the lock guard would have to be held while the serialization moves between threads.

Required Methods§

Source

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

Serializes the value.

Provided Methods§

Source

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

This is primarily useful to undo some state change in the serializer state at the end of the processing.

Source

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

This can be used by an emitter to skip over values that are currently in the optional state. For instance Option<T> returns true here if the value is None and the struct emitter created by the derive feature will skip over these if #[deser(skip_serializing_optionals)] is set on the struct.

Source

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

This is only invoked by formats which want to reflect the Rust shape of values, see Describe. The default implementation describes nothing. Wrappers which serialize as the value they wrap should describe themselves and then delegate to the wrapped value.

Source

fn container_shape(value: &T) -> ContainerShape

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

The shape is passed on with the MapStart or SeqStart event, it’s ignored for other values. The default is ContainerShape::new.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait Serialize Copy item path

§Adapters

§Thread Safety

Required Methods§

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

Provided Methods§

fn finish(value: &T, state: &mut State) -> Result<(), Error>

fn is_optional(value: &T) -> bool

fn describe(value: &T, d: &mut dyn Describe)

fn container_shape(value: &T) -> ContainerShape

Dyn Compatibility§

Implementations on Foreign Types§

impl Serialize for ()

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

fn is_optional(_value: &Self) -> bool

impl Serialize for AtomicBool

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

impl Serialize for AtomicI8

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

impl Serialize for AtomicI16

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

impl Serialize for AtomicI32

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

impl Serialize for AtomicI64

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

impl Serialize for AtomicIsize

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

impl Serialize for AtomicU8

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

impl Serialize for AtomicU16

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

impl Serialize for AtomicU32

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

impl Serialize for AtomicU64

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

impl Serialize for AtomicUsize

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

impl Serialize for BStr

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

impl Serialize for BString

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

impl Serialize for BigDecimal

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

impl Serialize for BigInt

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

impl Serialize for BigUint

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

impl Serialize for Bytes

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

impl Serialize for BytesMut

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

impl Serialize for CStr

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

impl Serialize for CString

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

impl Serialize for Date

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

impl Serialize for Date

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

impl Serialize for DateTime

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

impl Serialize for DateTime<FixedOffset>

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

impl Serialize for DateTime<Utc>

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

impl Serialize for Decimal

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

impl Serialize for Duration

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

impl Serialize for Duration

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

impl Serialize for Infallible

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

impl Serialize for IpAddr

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

impl Serialize for Ipv4Addr

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

impl Serialize for Ipv6Addr

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

impl Serialize for NaiveDate

Trait Serialize