Struct SerializerConfig 

pub struct SerializerConfig { /* private fields */ }

Configures how values are serialized.

The output can be read with Python’s pickle.loads (see the crate documentation). The options are the protocol and the Context.

use deser_pickle::SerializerConfig;

const CONFIG: SerializerConfig = SerializerConfig::builder().protocol(2).build();
assert_eq!(CONFIG.to_vec(&vec![1, 2]).unwrap(), b"\x80\x02](K\x01K\x02e.");

Implementations

impl SerializerConfig

pub const fn new() -> SerializerConfig

Creates the default configuration.

pub const fn builder() -> SerializerConfigBuilder

Returns a builder for the configuration (see SerializerConfigBuilder).

pub const fn into_builder(self) -> SerializerConfigBuilder

Returns a builder that starts with this configuration.

pub fn set_context(&mut self, context: Context)

Sets the context the values are serialized in.

The values of the context are the defaults of the extension values of the state (see Context). The serializers and writers created with the configuration use this context. A context set on the driver takes precedence.

pub fn context(&self) -> &Context

Returns the context the values are serialized in.

pub fn set_protocol(&mut self, protocol: u8)

Sets the protocol that is written.

Protocols 2 to 5 are supported, the default is 4 (which Python reads since 3.4). Protocol 2 can be read by Python 2. Serializing fails with other protocols.

pub fn protocol(&self) -> u8

Returns the protocol that is written.

pub fn to_vec<T: Serialize + ?Sized>(&self, value: &T) -> Result<Vec<u8>, Error>

Serializes the given value.

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

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

Serializes the given value with a configured driver.

The callback is invoked with the driver before the serialization starts, for instance to add Layers.

impl SerializerConfig

pub fn writer<W: Write>(&self, writer: W) -> Writer<W, Serializer>

Creates a writer of values (see deser::io::Writer).

Every value is written as a pickle once it’s complete.

pub fn to_writer<W: Write, T: Serialize + ?Sized>( &self, writer: W, value: &T, ) -> Result<(), Error>

Serializes a value to a writer.

See to_writer.

Trait Implementations

impl Clone for SerializerConfig

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 SerializerConfig

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

Formats the value using the given formatter.

impl Default for SerializerConfig

fn default() -> SerializerConfig

Returns the “default value” for a type.

impl Eq for SerializerConfig

impl PartialEq for SerializerConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SerializerConfig