Struct Serializer 

pub struct Serializer { /* private fields */ }

Serializes values into property lists.

A property list holds a single value.

use deser_plist::Serializer;

let mut serializer = Serializer::new();
serializer.serialize(&true).unwrap();
assert!(serializer.output().ends_with(b"<plist version=\"1.0\">\n<true/>\n</plist>\n"));

The serializer is also the stream serializer of property lists (see StreamSerializer). XML and OpenStep property lists can be written in parts, binary property lists are written once the value is complete as the object table needs all objects. To write to a Write use SerializerConfig::writer.

Implementations

impl Serializer

pub fn new() -> Serializer

Creates a serializer.

pub fn with_config(config: SerializerConfig) -> Serializer

Creates a serializer with the given configuration.

pub fn config(&self) -> &SerializerConfig

Returns the configuration.

pub fn written(&self) -> bool

Returns true once the value was written.

pub fn serialize<T: Serialize + ?Sized>( &mut self, value: &T, ) -> Result<(), Error>

Serializes a value.

A property list holds a single value, serializing a second value fails.

pub fn serialize_with<F, T: Serialize + ?Sized>( &mut self, value: &T, setup: F, ) -> Result<(), Error>

where F: FnOnce(&mut SerializeDriver<'_>),

Serializes a value with a configured driver.

The callback is invoked with the driver before the value is serialized, for instance to add Layers.

pub fn output(&self) -> &[u8]

Returns the output written so far (that was not cleared).

pub fn finish(self) -> Vec<u8>

Returns the output.

Trait Implementations

impl Clone for Serializer

fn clone(&self) -> Serializer

Clones the serializer.

The clone of a serializer that writes a value in parts cannot write more values (see StreamSerializer::in_progress).

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

Performs copy-assignment from source.

impl Debug for Serializer

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

Formats the value using the given formatter.

impl Default for Serializer

fn default() -> Self

Returns the “default value” for a type.

impl Serializer for Serializer

fn drive(&mut self, driver: &mut SerializeDriver<'_>) -> Result<(), Error>

Receives the events of a value from the driver and writes them into the output.

fn serialize<T>(&mut self, value: &T) -> Result<(), Error>

where T: Serialize + ?Sized, Self: Sized,

Serializes a value.

fn serialize_with<T, F>(&mut self, value: &T, setup: F) -> Result<(), Error>

where T: Serialize + ?Sized, F: FnOnce(&mut SerializeDriver<'_>), Self: Sized,

Serializes a value with a configured driver.

fn serialize_ref(&mut self, value: SerializeRef<'_>) -> Result<(), Error>

Serializes the value of a reference.

impl StreamSerializer for Serializer

fn supports_partial(&self) -> bool

XML and OpenStep property lists are written in parts.

fn output(&self) -> &[u8]

Returns the bytes serialized so far which were not cleared yet.

fn clear_output(&mut self)

Discards the bytes returned by output, for instance because they were written.

fn drive_partial( &mut self, driver: &mut SerializeDriver<'_>, limit: usize, ) -> Result<bool, Error>

Serializes a value, or a part of it, and appends its bytes to the output.

fn in_progress(&self) -> bool

Returns true if a value is partially serialized.