pyzim.blob.EntryBlob

class documentation

class EntryBlob(BaseBlob):

Method	`__init__`	The default constructor.
Method	`close`	Called when this blob is no longer needed.
Method	`get_size`	Return the size of this blob.
Method	`read`	Read up to n bytes from the blob.
Instance Variable	`_closed`	Undocumented
Instance Variable	`_entry`	Undocumented
Instance Variable	`_read_iter`	Undocumented
Instance Variable	`_size`	Undocumented

def __init__(self, entry, size=None): ¶

The default constructor.

Parameters
entry:`pyzim.entry.ContentEntry`	entry to get content from
size:`int` or `None`	size of the entry. Setting this improves performance.

def close(self): ¶

overrides pyzim.blob.BaseBlob.close

Called when this blob is no longer needed.

Use this method to clean up any associated resources.

def get_size(self): ¶

overrides pyzim.blob.BaseBlob.get_size

Return the size of this blob.

This value should never be lower than the actual size.

Returns
`int`	the size of this blob in bytes

def read(self, n): ¶

overrides pyzim.blob.BaseBlob.read

Read up to n bytes from the blob.

The "n" parameter indicates the max amount of bytes that should be returned. It is meant as a mere suggestion and can safely be ignored.

This function should return an empty bytestring if all data has been read.

Returns
`bytes`	a chunk of data read from the blob

_closed: bool = ¶

Undocumented

_entry = ¶

Undocumented

_read_iter = ¶

Undocumented

_size = ¶

Undocumented