Struct FrameWriter 

pub struct FrameWriter<'o> { /* private fields */ }

A sink that writes one value node onto the end of a buffer. Unknown container lengths are patched in at end.

Implementations

impl<'o> FrameWriter<'o>

pub fn new(out: &'o mut Vec<u8>) -> Self

pub fn at_depth(out: &'o mut Vec<u8>, depth: usize) -> Self

A writer for a node that sits depth levels below the top of a document, so MAX_DEPTH counts from the top: for a subtree written to a buffer of its own and copied into the document later.

pub fn depth(&self) -> usize

How many levels below the top of its document this writer’s node sits.

Trait Implementations

impl<'o> Sink for FrameWriter<'o>

fn typed_null(self, _: FixedType) -> Result<(), FrameWriteError>

Written as the plain null. A frame is plaintext, never sealed, so padding hides nothing in it: what a frame writer produces goes to a host (the frame decrypt_to_frame returns) or into the clear (a passthrough subtree), where the plain null is what every reader already knows. A frame a host sends may still carry a typed null, which Frame reads, so the host’s absent values are padded when sealed.

type Ok = ()

What the sink produces when the walk ends.

type Error = FrameWriteError

The sink’s error, which can also carry a SourceError.

type Seq = FrameSeq<'o>

The sink for a sequence’s elements.

type Map = FrameMap<'o>

The sink for a map’s entries.

fn scalar( self, ty: Option<Logical>, v: Physical<'_>, ) -> Result<(), FrameWriteError>

One scalar: a physical value, and the logical type it represents, if any. See kinds.

fn seq(self, len: Option<usize>) -> Result<FrameSeq<'o>, FrameWriteError>

Start a sequence. len is a hint; a source that does not know its length passes None.

fn map(self, len: Option<usize>) -> Result<FrameMap<'o>, FrameWriteError>

Start a map with string keys. len is a hint.

fn passthrough<P: Encrypt + Clone>( self, value: P, ) -> Result<(), FrameWriteError>

A subtree that travels in the clear. It is walked like anything else; the sink decides what “in the clear” means for it.