Skip to main content

Metadata

Struct Metadata 

Source
pub struct Metadata { /* private fields */ }
Expand description

Validated compact frame metadata, with cached scalar totals only. Append sizes after the corresponding frame has been written successfully.

Implementations§

Source§

impl Metadata

Source

pub fn new(config: Config) -> Self

Start an empty object. This allocates no index entries.

Source

pub fn from_parts(parts: MetadataParts) -> Result<Self>

Restore and validate trusted external metadata without copying its arrays. Fixed uncompressed metadata is checked in O(1); indexed modes in O(N).

Source

pub fn parts(&self) -> &MetadataParts

Borrow the validated persistence representation.

Source

pub fn into_parts(self) -> MetadataParts

Transfer the persistence representation without copying.

Source

pub fn config(&self) -> &Config

Object-wide configuration.

Source

pub fn frame_count(&self) -> u64

Exact number of frames.

Source

pub fn logical_len(&self) -> u64

Logical object length, in bytes.

Source

pub fn stored_len(&self) -> u64

Stored object length including tags, in bytes.

Source

pub fn last_frame_len(&self) -> Option<u64>

Last raw frame length; absent for an empty object.

Source

pub fn push(&mut self, sizes: FrameSizes) -> Result<()>

Append one successfully stored frame. Failures leave metadata unchanged. Once a short fixed frame is appended, no further frames may follow it.

Source

pub fn frame(&self, index: u64) -> Option<FrameSpec>

Look up a codec descriptor by its original frame index in O(1).

Source

pub fn range( &self, start: u64, end: Option<u64>, ) -> Result<(Range<u64>, FrameIter<'_>)>

Map logical [start, end) bytes to a physical range of complete frames. None means logical EOF. Empty ranges return 0..0 and an empty iterator. No allocation, I/O, or decoding occurs. Variable-size layouts scan their compact index to the last selected frame; fixed uncompressed layouts use arithmetic.

Trait Implementations§

Source§

impl Clone for Metadata

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Metadata

Source§

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

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

impl Eq for Metadata

Source§

impl PartialEq for Metadata

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Metadata

Source§

impl TryFrom<&Metadata> for Encoder

Source§

type Error = Error

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

fn try_from(metadata: &Metadata) -> Result<Self>

Performs the conversion.
Source§

impl TryFrom<&Metadata> for Decoder

Source§

type Error = Error

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

fn try_from(metadata: &Metadata) -> Result<Self>

Performs the conversion.
Source§

impl TryFrom<Metadata> for Encoder

Source§

type Error = Error

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

fn try_from(metadata: Metadata) -> Result<Self>

Performs the conversion.
Source§

impl TryFrom<Metadata> for Decoder

Source§

type Error = Error

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

fn try_from(metadata: Metadata) -> Result<Self>

Performs the conversion.

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.