Skip to main content

ChunkRecord

Struct ChunkRecord 

Source
#[non_exhaustive]
pub struct ChunkRecord { pub chunk: Chunk, pub tag: ChunkTag, pub body_offset: u64, pub bytes_read: u64, }
Expand description

One chunk yielded by ZiPatchReader::next_chunk together with the stream-position metadata the parser observed while reading it.

Bundling the chunk with its byte-position metadata in one record lets downstream consumers (the apply driver, the crate::index::PlanBuilder, the zipatch dump CLI) avoid a second round of accessor calls against the reader to learn where the chunk sat in the stream. Each field describes one fact the parser knew at the moment the chunk was yielded; see the per-field docs.

#[non_exhaustive]: stream-position metadata may grow (e.g. compressed payload size, header-only byte count) as new index-builder needs surface.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§chunk: Chunk

The parsed chunk itself.

§tag: ChunkTag

The 4-byte ASCII wire tag of the chunk (FHDR, SQPK, EOF_, …).

Exposed alongside Self::chunk so consumers can attach the tag to a progress event without re-matching on the Chunk enum.

§body_offset: u64

Absolute patch-file offset of the chunk’s body — the byte right after the 8-byte [body_len: u32 BE, tag: [u8; 4]] frame header.

Index builders use this to compute absolute patch-file offsets for SqpkAddData::data, SqpkFile block payloads, and SqpkHeader::header_data without re-walking the stream.

§bytes_read: u64

Running total of bytes consumed from the patch stream, including the 12-byte magic header, the chunk this record describes, and every preceding chunk frame.

Equivalent to the crate::ChunkEvent::bytes_read field at the same emission point; used for the bytes_applied / total_patch_size progress-bar ratio.

Trait Implementations§

Source§

impl Debug for ChunkRecord

Source§

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

Formats the value using the given formatter. Read more

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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