Struct Serializer

pub struct Serializer { /* private fields */ }

Serializer pipe: push T; pull u8.

The push and pull calls can signify “blocking” – i.e. they’re awaiting the other call – by returning None.

A Some returned signifies readiness, holding an impl FnOnce that you can call to perform the push/pull.

Example

use serde_pipe::Serializer;

let large_vector = (0..1u64<<30).collect::<Vec<_>>();
let mut serializer = Serializer::new();
serializer.push().unwrap()(large_vector);

while let Some(pull) = serializer.pull() {
	let byte = pull();
	println!("byte! {}", byte);
}

Panics

Will panic if dropped while non-empty. In practise this almost always signifies a bug. If you do want to drop it when non-empty, call Serializer::empty() before dropping it.

Implementations

impl Serializer

pub fn new() -> Self

Construct a new Serializer pipe.

pub fn push<'a, T: Serialize + 'static>( &'a mut self, ) -> Option<impl FnOnce(T) + 'a>

Push a T to the Serializer pipe. None denotes that the Serializer is instead awaiting a pull. Some contains an impl FnOnce(T) that can be called to perform the push.

pub fn pull<'a>(&'a mut self) -> Option<impl FnOnce() -> u8 + 'a>

Pull a T from the Serializer pipe. None denotes that the Serializer is instead awaiting a push. Some contains an impl FnOnce() -> u8 that can be called to perform the pull.

pub fn empty<'a>(&'a mut self) -> Option<impl FnOnce() + 'a>

Empty this pipe. None denotes it’s already empty. Some contains an impl FnOnce() that can be called to perform the empty.

Trait Implementations

impl Debug for Serializer

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

Formats the value using the given formatter.

impl Drop for Serializer

fn drop(&mut self)

Executes the destructor for this type.