Struct SerializeHandle 

pub struct SerializeHandle<'a>(/* private fields */);

A handle to a value that is serialized.

During serialization it’s common to be in a situation where one needs to return a locally constructed Serialize. This is where SerializeHandle comes in. The handle either borrows the value (see to and SerializeRef) or owns it (see arena and heap).

Unlike the SinkHandle of deserialization, which holds a sink that is already deserializing a value, this holds a value that is not serialized yet. The serialization equivalent of a sink is an emitter in a Emit. The constructors line up: to borrows, arena and heap own in the same way for both handles.

Implementations

impl<'a> SerializeHandle<'a>

pub fn to<S: Serialize>(value: &'a S) -> SerializeHandle<'a>

Creates a borrowed handle to a value.

pub fn arena<S: Serialize + Send + 'a>( value: S, state: &mut State, ) -> SerializeHandle<'a>

Creates an owned handle to a value in the arena of the state.

This is how owned values are typically created (for instance for Emit::Forward), see Boxed.

pub fn heap<S: Serialize + Send + 'a>(value: S) -> SerializeHandle<'a>

Creates an owned handle to a value on the heap.

Unlike arena the value does not need a state and is independent of any serialization.

pub fn get(&self) -> SerializeRef<'_>

Returns a reference to the value.

Trait Implementations

impl Debug for SerializeHandle<'_>

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

Formats the value using the given formatter.

impl<'a> From<SerializeRef<'a>> for SerializeHandle<'a>

fn from(value: SerializeRef<'a>) -> SerializeHandle<'a>

Converts to this type from the input type.

impl Serialize for SerializeHandle<'_>

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

Serializes the value.

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

Invoked after the serialization finished.

fn is_optional(value: &Self) -> bool

Checks if the value represents an optional value.

fn container_shape(value: &Self) -> ContainerShape

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

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

Describes the Rust shape of the value.