class documentation

class PackStreamReader(object):

Known subclasses: dulwich.pack.PackStreamCopier

View In Hierarchy

Class to read a pack stream.

The pack is read from a ReceivableProtocol using read() or recv() as appropriate.

Method __init__ Undocumented
Method __len__ Undocumented
Method read Read, blocking until size bytes are read.
Method read_objects Read the objects in this pack file.
Method recv Read up to size bytes, blocking until one byte is read.
Instance Variable read_all Undocumented
Instance Variable read_some Undocumented
Instance Variable sha Undocumented
Property offset Undocumented
Method _buf_len Undocumented
Method _read Read up to size bytes using the given callback.
Instance Variable _num_objects Undocumented
Instance Variable _offset Undocumented
Instance Variable _rbuf Undocumented
Instance Variable _trailer Undocumented
Instance Variable _zlib_bufsize Undocumented
def __init__(self, read_all, read_some=None, zlib_bufsize=_ZLIB_BUFSIZE):

Undocumented

def __len__(self):

Undocumented

def read(self, size):

Read, blocking until size bytes are read.

def read_objects(self, compute_crc32=False):

Read the objects in this pack file.

Returns: Iterator over UnpackedObjects with the following members set:
offset obj_type_num obj_chunks (for non-delta types) delta_base (for delta types) decomp_chunks decomp_len crc32 (if compute_crc32 is True)
Parameters
compute_crc32If True, compute the CRC32 of the compressed data. If False, the returned CRC32 will be None.
Raises
ChecksumMismatchif the checksum of the pack contents does not match the checksum in the pack trailer.
zlib.errorif an error occurred during zlib decompression.
IOErrorif an error occurred writing to the output file.
def recv(self, size):

Read up to size bytes, blocking until one byte is read.

read_all =

Undocumented

read_some =

Undocumented

sha =

Undocumented

@property
offset =

Undocumented

def _buf_len(self):

Undocumented

def _read(self, read, size):

Read up to size bytes using the given callback.

As a side effect, update the verifier's hash (excluding the last 20 bytes read).

Parameters
readThe read callback to read from.
sizeThe maximum number of bytes to read; the particular behavior is callback-specific.
_num_objects =

Undocumented

_offset: int =

Undocumented

_rbuf =

Undocumented

_trailer =

Undocumented

_zlib_bufsize =

Undocumented