b.p.BytesRecordReader(BaseReader) : class documentation

Part of bzrlib.pack View In Hierarchy

No class docstring
Method read Read this record.
Method validate Validate this record.
Method _content_reader Undocumented

Inherited from BaseReader:

Method __init__ Constructor.
Method reader_func Undocumented
Method _read_line Undocumented
def read(self):
Read this record.

You can either validate or read a record, you can't do both.

ReturnsA tuple of (names, callable). The callable can be called repeatedly to obtain the bytes for the record, with a max_length argument. If max_length is None, returns all the bytes. Because records can be arbitrarily large, using None is not recommended unless you have reason to believe the content will fit in memory.
def _content_reader(self, max_length):
Undocumented
def validate(self):
Validate this record.

You can either validate or read, you can't do both.

RaisesContainerErrorif this record is invalid.
API Documentation for Bazaar, generated by pydoctor at 2019-10-20 00:34:54.