Struct SegmentFraming 

pub struct SegmentFraming { /* private fields */ }

Segment framing information decoded from a FLOE segment prefix.

Construct this with Self::decode. A streaming decryptor can use Self::ciphertext_length to read the remainder of the segment and Self::plaintext_length to size an output buffer.

Implementations

impl SegmentFraming

pub fn decode(parameters: Parameters, prefix: [u8; 4]) -> Result<Self>

Decodes the unauthenticated framing declared by a segment prefix.

This does not authenticate the prefix or the rest of the segment. You must successfully decrypt the segment before trusting it.

Errors

Returns Error::InvalidCiphertextLength when a final prefix encodes a length outside the supported range.

pub const fn ciphertext_length(self) -> usize

Returns the complete ciphertext segment length.

pub const fn plaintext_length(self) -> usize

Returns the segment’s plaintext payload length.

pub const fn is_final(self) -> bool

Returns whether the prefix identifies a final segment.

pub const fn kind(self) -> SegmentKind

Returns whether the prefix identifies an internal or final segment.

Trait Implementations

impl Clone for SegmentFraming

fn clone(&self) -> SegmentFraming

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SegmentFraming

impl Debug for SegmentFraming

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

Formats the value using the given formatter.

impl Eq for SegmentFraming

impl PartialEq for SegmentFraming

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SegmentFraming