Skip to main content

Q42Volume

Struct Q42Volume 

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

Memory-mapped unified v2 volume reader.

Implementations§

Source§

impl Q42Volume

Source

pub fn block_cursor(&self) -> Q42BlockCursor<'_>

Return a sequential cursor which decodes into a caller-owned buffer.

Source§

impl Q42Volume

Source

pub fn open(path: &Path) -> Result<Self>

Source

pub fn header(&self) -> &Q42VolumeHeader

Source

pub fn as_bytes(&self) -> &[u8]

Source

pub fn lex_bytes(&self) -> &[u8]

Source

pub fn lex_view(&self) -> Result<Q42LexMmap<'_>, LexError>

Source

pub fn bidx_bytes(&self) -> &[u8]

Source

pub fn volume_manifest_bytes(&self) -> Result<Option<&[u8]>>

Return the root descriptor bytes embedded between the lexicon and BIDX.

Source

pub fn volume_manifest(&self) -> Result<Option<Q42VolumeManifest>>

Decode the front-embedded descriptor for a logical multi-segment Q42 snapshot. A regular v3 Q42 returns Ok(None).

Source

pub fn block_count(&self) -> u64

Source

pub fn verify_all_blocks(&self) -> Result<Q42VerificationReceipt>

Decode and verify every block without materialising the graph. This checks SuperBlock counts, parity, per-block/global object ordering, and the BIDX range advertised for each block. Logical roots have no local records and must be verified through their manifest children.

Source

pub fn bidx_blocks_for_hash(&self, object_hash: u64) -> Vec<usize>

Binary-search BIDX for object_hash; returns block indices that may contain it.

This allocating compatibility helper now returns the complete matching interval. New query paths should use Self::bidx_blocks_for_hash_into to enumerate a high-frequency object through a caller buffer.

Source

pub fn bidx_block_range_for_hash( &self, object_hash: u64, ) -> Result<Option<BidxBlockRange>>

Return the full contiguous BIDX interval that may contain object_hash.

Source

pub fn bidx_blocks_for_hash_into( &self, object_hash: u64, cursor: usize, out: &mut [usize], ) -> Result<Option<BidxMatchPage>>

Fill out with one page of matching BIDX block indices.

cursor is an offset relative to the returned interval’s start. Resume with next_cursor until it is None; an empty output buffer never causes a silent partial success.

Source

pub fn object_hash_bounds(&self) -> Option<(u64, u64)>

Minimum and maximum object hash advertised by this segment’s validated BIDX. Empty root/catalog segments return None.

Source

pub fn block_directory_entry(&self, index: usize) -> Result<BlockDirectoryEntry>

Source

pub fn read_superblock_into( &self, index: usize, out: &mut [u8], ) -> Result<usize>

Decompress SuperBlock index into out (must be >= 40960 bytes).

Source

pub fn read_all_quins(&self) -> Result<Vec<NQuin>>

Read every live Quin from this volume’s SuperBlocks into a heap Vec.

Cold path (CLI / daemon vault load). A .q42 is not a flat array of 48-byte records — each SuperBlock is LZ4-compressed and carries a 160-byte header whose bytes [16..24] hold the block’s live quin count. Callers that bytemuck::cast_slice the raw file will panic (OutputSliceWouldHaveSlop) because the file length is not a multiple of QUIN_SIZE. Use this instead.

Auto Trait Implementations§

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<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: 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: 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
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 = 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.
§

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> 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
§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

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,