Skip to main content

BundleReader

Struct BundleReader 

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

A parsed, integrity-checked view over a .hmc bundle’s bytes. Borrows the input; get/segment return slices into it (zero copy).

Implementations§

Source§

impl<'a> BundleReader<'a>

Source

pub fn parse_with_limits( bytes: &'a [u8], limits: BundleReadLimits, ) -> Result<Self, BundleError>

Bounded cold admission for the current definite-length index encoding. Shared preflight borrows CBOR fields before cold materialization can allocate. Unknown fields, indefinite encodings and trailing index data require an explicit compatibility profile instead of implicit skipping. This verifies bytes and structure, not source rights or asset acceptance.

Source

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

Parse and fully validate a bundle: magic, version, declared length, whole-file CRC, and every entry’s bounds. On success the payloads are known-good and in-bounds, so get/segment are total on valid keys.

Source

pub fn entries(&self) -> &[BundleEntry]

The bundle’s entries (index order).

Source

pub fn flags(&self) -> u16

Reserved format flags from the header (0 in v1; reserved for future use such as a signed/compressed-entry variant).

Source

pub fn is_page_aligned_4096(&self) -> bool

True when the bundle header declares 4096-byte OS page alignment.

Source

pub fn entry(&self, key: &str) -> Option<&BundleEntry>

The index record for key, if present.

Source

pub fn get(&self, key: &str) -> Option<&'a [u8]>

A zero-copy slice of the intact embedded file for key. This slice is a byte-identical standalone .q42 / .10d / .p64 — hand it straight to that format’s reader.

Source

pub fn segment( &self, key: &str, seg_offset: u64, seg_len: u64, ) -> Option<&'a [u8]>

A zero-copy slice of an interior segment of an entry ([seg_offset .. seg_offset+seg_len) within the embedded file). Returns None if the key is unknown or the segment runs past the entry — proving the bundle does not interfere with segment-level access into an entry.

Source

pub fn verify_entry(&self, key: &str) -> bool

Verify one entry’s payload against its recorded SHA-256.

Source

pub fn get_family_manifest( &self, ) -> Result<Option<TwinFamilyManifest>, BundleError>

Retrieve and decode the embedded digital twin family manifest, if present.

Source

pub fn get_species_meta( &self, ) -> Result<Option<HolisticSpeciesMeta>, BundleError>

Retrieve and decode the embedded holistic species metadata, if present.

Auto Trait Implementations§

§

impl<'a> Freeze for BundleReader<'a>

§

impl<'a> RefUnwindSafe for BundleReader<'a>

§

impl<'a> Send for BundleReader<'a>

§

impl<'a> Sync for BundleReader<'a>

§

impl<'a> Unpin for BundleReader<'a>

§

impl<'a> UnsafeUnpin for BundleReader<'a>

§

impl<'a> UnwindSafe for BundleReader<'a>

Blanket Implementations§

§

impl<S, A> Aggregate<Result<S, Error>> for A
where A: Aggregate<S>,

§

fn from_shares<T>(iter: T) -> Result<A, Error>
where T: IntoIterator<Item = Result<S, Error>>,

Aggregate shares in an MPC protocol.
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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more