Skip to main content

SeekDirectory

Struct SeekDirectory 

Source
pub struct SeekDirectory {
    pub section_flags: u8,
    pub entries: Vec<DirectoryEntry>,
    pub classes: Vec<ClassEntry>,
    pub channel_lengths: Vec<u64>,
}
Expand description

A decoded DIRECTORY record payload.

Field vectors correspond to the sections named by section_flags; vectors for absent sections are empty.

Fields§

§section_flags: u8

Section flags present in the encoded record.

§entries: Vec<DirectoryEntry>

Record locators in file order, when SECTION_LOCATORS is set.

§classes: Vec<ClassEntry>

Per-class index, when SECTION_CLASS_INDEX is set.

§channel_lengths: Vec<u64>

Per-ENTROPY_CHANNEL decoded length in table order, when SECTION_CHANNEL_LENGTHS is set.

Implementations§

Source§

impl SeekDirectory

Source

pub fn encode(&self) -> Result<Vec<u8>>

Encode the payload to canonical bytes.

A section’s flag and its vector must agree: a set flag with an empty vector is encoded as a count of zero (valid), but a clear flag with a non-empty vector is an error rather than a silently dropped section.

Source

pub fn decode(bytes: &[u8], limits: Limits) -> Result<SeekDirectory>

Decode and structurally bound a payload.

This checks the size bound, the version, the section flags, and that every section fits its declared count. It does not check agreement with the actual record framing; call SeekDirectory::validate for that.

Source

pub fn validate( &self, records: &[RecordSite], file_len: u64, limits: Limits, ) -> Result<()>

Validate the directory against the actual record framing.

Runs the internal structural checks and then requires that Self::entries agrees byte-for-byte with records (tag, offset, payload length). This is the advisory cross-check: the directory is a claim, and the framing is the authority.

Source

pub fn validate_structural(&self, file_len: u64, limits: Limits) -> Result<()>

Validate the directory’s internal consistency and its coverage of the file.

This needs only the directory and the file length, so a seek reader can run it without reading the whole record set.

Trait Implementations§

Source§

impl Clone for SeekDirectory

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 SeekDirectory

Source§

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

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

impl Default for SeekDirectory

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SeekDirectory

Source§

impl PartialEq for SeekDirectory

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 SeekDirectory

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.