Skip to main content

Descriptor

Struct Descriptor 

Source
pub struct Descriptor {
    pub universe: String,
    pub source_format: u8,
    pub format_basis: String,
    pub models: Vec<EntropyModel>,
    pub channels: Vec<EntropyChannelDescriptor>,
    pub objects: Vec<ObjectSource>,
    pub program: Program,
    pub observation_index: Option<ObservationIndex>,
    pub seek_directory: bool,
    pub source_sha256: [u8; 32],
    pub source_len: u64,
}
Expand description

The in-memory model of a .voldoc descriptor.

Fields§

§universe: String

Universe declaration string.

§source_format: u8

Source-format class selector.

§format_basis: String

Human-readable basis for the format decision (provenance, not trust).

§models: Vec<EntropyModel>

Canonical entropy models referenced by channels.

§channels: Vec<EntropyChannelDescriptor>

Typed entropy channels referenced by the program.

§objects: Vec<ObjectSource>

Raw byte objects referenced by the program.

§program: Program

The reconstruction program.

§observation_index: Option<ObservationIndex>

Optional advisory observation index (Phase 7.3).

None is today’s descriptor and fully materializes. When Some, the record is validated against the program at parse time; it is never authority.

§seek_directory: bool

Whether to emit an optional seek DIRECTORY record (Phase 8).

false is today’s descriptor and produces the exact Phase-7 record sequence (the universe string still carries the Phase-8 suffix). When true, serialize writes a two-pass DIRECTORY record as the first record; a directory requires an observation index to describe.

§source_sha256: [u8; 32]

SHA-256 of the exact reconstructed source.

§source_len: u64

Exact reconstructed source length.

Implementations§

Source§

impl Descriptor

Source

pub fn header(&self) -> Header

The header that this descriptor serializes to.

Source

pub fn required_features(&self) -> u32

Mandatory feature bits implied by this descriptor’s contents.

Derived rather than stored, so no constructor can forget to declare a feature: a descriptor carrying a DEFLATE_REPLAY op always sets crate::container::header::FEATURE_DEFLATE_REPLAY in its header, and a build without that feature rejects it at header validation.

Source

pub fn optional_features(&self) -> u32

Optional feature bits implied by this descriptor’s contents.

Optional bits are ignorable: a decoder that does not understand them still materializes the source exactly. The observation-index bit records only that a partial-decode lane is available, and the seek-directory bit only that a seek-based lane is available; exactness never requires either.

Source

pub fn serialize(&self) -> Result<(Vec<u8>, CostBreakdown)>

Serialize to a complete .voldoc byte sequence plus cost attribution.

When Descriptor::seek_directory is set this is a two-pass build: every record payload is encoded first, the seek directory’s length is computed from counts alone (so there is no chicken-and-egg), then the records are emitted after the directory. A descriptor without a directory emits exactly the record sequence and bytes it emitted before this field existed, and cost.directory == 0.

Source

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

Parse a complete .voldoc byte sequence with structural validation.

This validates framing, universe identity, version, mandatory features, record presence, the coverage certificate, and declared length. It does not materialize or hash the reconstructed source; call crate::materialize::materialize for that.

Trait Implementations§

Source§

impl Clone for Descriptor

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 Descriptor

Source§

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

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

impl Eq for Descriptor

Source§

impl PartialEq for Descriptor

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 Descriptor

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.