Struct Frame 

pub struct Frame<'a> { /* private fields */ }

Exactly one validated value node, borrowed.

A frame of plaintext is plaintext, so Debug is redacted and == is constant time.

Implementations

impl<'a> Frame<'a>

pub fn parse(bytes: &'a [u8]) -> Result<Self, FrameError>

Validate bytes as exactly one value node.

The whole frame is checked up front, so visit never has to report a malformed frame part way through a walk.

pub fn parse_nested( bytes: &'a [u8], depth: usize, ) -> Result<(Self, &'a [u8]), FrameError>

Validate the value node at the start of bytes, and return it with the bytes after it.

For a frame embedded in a larger structure, such as the passthrough payload of a ciphertext node. depth is how many levels the carrier already nests the node, so the MAX_DEPTH bound counts the whole structure and not the frame alone.

pub fn as_bytes(&self) -> &'a [u8]

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Frame<'a>

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl Encrypt for Frame<'_>

A frame walked in place: no scalar leaves the buffer except to go straight to the sink.

fn visit<S: Sink>(self, sink: S) -> Result<S::Ok, S::Error>

Describe self to sink, consuming it.

const DEPTH: Option<usize> = None

How deep a value of this type can nest below its own root, when the type alone fixes it: Some(0) for a scalar, one more than its deepest child for a sequence or map (see depth). None, the default, when it depends on the value: a recursive type, a frame, a live host value.

const FIXED: Option<FixedType> = None

The fixed-width scalar type every value of this type has, if it has one: an int, a float, a date, a timestamp, a decimal. None, the default, for everything else: a bool (whose leaf is already as short as a null’s), text, bytes, a container, a value whose type depends on the value.

impl Encrypt for &Frame<'_>

A borrowed frame is the same frame: it is a view, and Copy.

fn visit<S: Sink>(self, sink: S) -> Result<S::Ok, S::Error>

Describe self to sink, consuming it.

const DEPTH: Option<usize> = None

How deep a value of this type can nest below its own root, when the type alone fixes it: Some(0) for a scalar, one more than its deepest child for a sequence or map (see depth). None, the default, when it depends on the value: a recursive type, a frame, a live host value.

const FIXED: Option<FixedType> = None

The fixed-width scalar type every value of this type has, if it has one: an int, a float, a date, a timestamp, a decimal. None, the default, for everything else: a bool (whose leaf is already as short as a null’s), text, bytes, a container, a value whose type depends on the value.

impl<'a> Eq for Frame<'a>

where &'a [u8]: TimingSafeEq,

impl<'a> OpaqueDebug for Frame<'a>

impl<'a> PartialEq for Frame<'a>

where &'a [u8]: TimingSafeEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> TimingSafeEq for Frame<'a>

where &'a [u8]: TimingSafeEq,

fn ts_eq(&self, __ts_other: &Self) -> Choice

Must be constant-time with respect to secret data.

fn ts_ne(&self, other: &Self) -> Choice