Skip to main content

PackStreamScanner

Struct PackStreamScanner 

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

Incremental object counter over a pack byte stream.

Feed it the pack’s bytes in order, starting at the PACK signature, in chunks of any size; Self::counts reports how many entries have been fully received.

Implementations§

Source§

impl PackStreamScanner

Source

pub fn new(hash: HashAlgo) -> Self

Create a scanner for a pack whose REF_DELTA bases are hash ids.

§Parameters
  • hash: the object format of the pack (decides the length of a REF_DELTA entry’s base id).
Source

pub fn counts(&self) -> Option<ReceivedObjects>

Objects received so far, or None until the pack header has arrived.

Source

pub fn is_complete(&self) -> bool

Whether every object named in the pack header has been received.

Source

pub fn feed(&mut self, data: &[u8]) -> Result<(), PackStreamScanError>

Scan the next data bytes of the pack.

§Parameters
  • data: the bytes that follow everything fed so far.
§Errors

Returns a PackStreamScanError when the bytes are not a well-formed pack. The scanner should be discarded after an error.

Trait Implementations§

Source§

impl Debug for PackStreamScanner

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