Struct MessageLayout 

pub struct MessageLayout { /* private fields */ }

Complete length and segment layout for one FLOE message.

Construct this with Parameters::plaintext_layout when the plaintext length is known, or Parameters::ciphertext_layout when the complete ciphertext length is known.

Each SegmentLayout supplies the offsets, lengths, position, and SegmentKind needed by the random-access encryption and decryption APIs.

Implementations

impl MessageLayout

pub fn final_segment(self) -> SegmentLayout

Returns the layout of this message’s final segment.

pub const fn parameters(self) -> Parameters

Returns the parameter set used by this layout.

pub const fn plaintext_length(self) -> u64

Returns the complete plaintext length.

pub const fn ciphertext_length(self) -> u64

Returns the complete ciphertext length, including the FLOE header.

pub const fn segment_count(self) -> u64

Returns the number of segments, including exactly one final segment.

pub fn segments(self) -> Segments

Iterates over every segment in position order.

See Self::segment_for_position when accessing an individual segment by position.

pub fn segment_for_position(self, position: u64) -> Option<SegmentLayout>

Returns the SegmentLayout of position, or None if it is outside this message.

The returned values can be passed directly to the corresponding random-access segment operation.

Trait Implementations

impl Clone for MessageLayout

fn clone(&self) -> MessageLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MessageLayout

impl Debug for MessageLayout

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

Formats the value using the given formatter.

impl Eq for MessageLayout

impl IntoIterator for MessageLayout

type Item = SegmentLayout

The type of the elements being iterated over.

type IntoIter = Segments

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for MessageLayout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MessageLayout