Skip to main content

Reader

Struct Reader 

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

Reader over one complete downloaded pack. Construction verifies its framing and hash; entries are then inflated/length-checked one at a time. Each call borrows caller staging storage and a reusable 32 KiB zlib window. Call finish (or read through None) to verify count and exact pack closure. Forward reference deltas require host base lookup; thin-pack bases may be supplied as ResolvedObject::external. No pack-index file parser is implied.

Implementations§

Source§

impl<'a> Reader<'a>

Source

pub fn new(pack: &'a [u8]) -> Result<Reader<'a>, Error>

Source

pub fn new_with_format( pack: &'a [u8], format: ObjectFormat, ) -> Result<Reader<'a>, Error>

Source

pub fn object_count(&self) -> u32

Source

pub fn remaining(&self) -> u32

Source

pub fn position(&self) -> u64

Source

pub fn pack_id(&self) -> ObjectId

Source

pub fn next_entry_size(&self) -> Result<Option<u64>, Error>

Inspect the next entry’s declared inflated body/instruction size without advancing. Hosts must apply their own budget before allocating storage. The declaration is checked against the actual stream by read_entry.

Source

pub fn read_entry<'out>( &mut self, output: &'out mut [u8], window: &mut [u8; 32768], limits: InflateLimits, ) -> Result<Option<Entry<'out>>, Error>

Read the next entry. Declared size is the inflated body/instruction size. A staging-capacity or budget error preserves the cursor for retry. Other errors also preserve the cursor; staging bytes may have changed.

Source

pub fn finish(&self) -> Result<(), Error>

Auto Trait Implementations§

§

impl<'a> Freeze for Reader<'a>

§

impl<'a> RefUnwindSafe for Reader<'a>

§

impl<'a> Send for Reader<'a>

§

impl<'a> Sync for Reader<'a>

§

impl<'a> Unpin for Reader<'a>

§

impl<'a> UnsafeUnpin for Reader<'a>

§

impl<'a> UnwindSafe for Reader<'a>

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, 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, 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.