ContainerFrame

Struct ContainerFrame 

Source
pub struct ContainerFrame<'a> { /* private fields */ }
Expand description

Borrowed view over a .lnmp container.

Implementations§

Source§

impl<'a> ContainerFrame<'a>

Source

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

Parses a .lnmp container from raw bytes.

Source

pub const fn header(&self) -> LnmpContainerHeader

Header describing this container.

Source

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

Metadata segment placed immediately after the header.

Source

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

Raw payload region.

Source

pub fn delta_apply_context(&self) -> Option<DeltaApplyContext>

Builds a delta apply context from the metadata (if mode is Delta).

Source

pub fn body(&self) -> ContainerBody<'a>

Returns a typed view over the payload bytes.

Source

pub fn decode_record(&self) -> Result<LnmpRecord, ContainerDecodeError>

Decodes the payload into a LnmpRecord using mode-specific codecs.

Source

pub fn stream_metadata(&self) -> Option<Result<StreamMetadata, MetadataError>>

Parses stream metadata if present (mode 0x03).

Source

pub fn delta_metadata(&self) -> Option<Result<DeltaMetadata, MetadataError>>

Parses delta metadata if present (mode 0x04).

Source

pub fn decode_to_text(&self) -> Result<String, ContainerDecodeError>

Canonicalizes the payload into LNMP text using Encoder.

Trait Implementations§

Source§

impl<'a> Clone for ContainerFrame<'a>

Source§

fn clone(&self) -> ContainerFrame<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ContainerFrame<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Copy for ContainerFrame<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ContainerFrame<'a>

§

impl<'a> RefUnwindSafe for ContainerFrame<'a>

§

impl<'a> Send for ContainerFrame<'a>

§

impl<'a> Sync for ContainerFrame<'a>

§

impl<'a> Unpin for ContainerFrame<'a>

§

impl<'a> UnwindSafe for ContainerFrame<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.