Struct Serializer 

pub struct Serializer { /* private fields */ }

Serializes values into PHP’s serialization format.

The values are appended to the output one after another (they can be read back with Deserializer::iter).

use deser_php::Serializer;

let mut serializer = Serializer::new();
serializer.serialize(&true).unwrap();
serializer.serialize(&"hi").unwrap();
assert_eq!(serializer.output(), b"b:1;s:2:\"hi\";");

The serializer is also the stream serializer of the format (see StreamSerializer). Values are written once they are complete as the lengths of arrays are written in front of them. 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 serialize<T: Serialize + ?Sized>( &mut self, value: &T, ) -> Result<(), Error>

Serializes a value and appends it to the output.

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) -> Self

Returns a duplicate of the value.

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 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 supports_partial(&self) -> bool

Returns true if the serializer implements drive_partial.

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.