pyzim.pointerlist.TitlePointerList

Constant

POINTER_FORMAT

Undocumented

Inherited from OrderedPointerList:

Class Method	from_bytes	Load a pointer list from the provided bytestring
Class Method	from_file	Load a pointer list from a file.
Class Method	from_zim_entry	Load a pointer list from an entry inside a ZIM archive.
Class Method	from_zim_file	Load a pointer list from a ZIM file at the specified offset.
Class Method	new	Instantiate a new, empty pointerlist.
Method	__init__	The default constructor.
Method	add	Add a key/pointer pair to this pointer list.
Method	check_sorted	Check that this list is actually ordered correctly.
Method	find_first_greater_equals	Return the index of the first value greater or equal to the key.
Method	get	Return the pointer for the specified key.
Method	get_index	Return the index of the pointer for the specified key.
Method	has	Check if this pointer list has a pointer matching the key.
Method	iter_values	Iterate over all values referenced by the pointers in this pointer list.
Method	print_content	Print the content of this pointerlist, including the keys.
Method	remove	Remove a pointer from this pointer list.
Instance Variable	_keyf	a function that returns the bytestring by which this pointer list is sorted

Inherited from SimplePointerList (via OrderedPointerList):

Method	__getitem__	Get the pointer at the specified index.
Method	__len__	The length of this pointer list.
Method	append	Append a pointer to the end of pointerlist.
Method	get_by_index	Return the pointer for the specified index.
Method	get_by_pointer	Return the index of pointer in this list.
Method	get_disk_size	Calculate the size of this object when written to a file.
Method	iter_pointers	Iterate over all pointers in this pointer list.
Method	mass_update	Perform a mass update on all pointers in the specified range, changing their value as specified.
Method	remove_by_index	Remove the pointer at the specified index.
Method	set	Set the pointer at the specified index.
Method	to_bytes	Dump this pointer list into a bytestring and return it.
Instance Variable	_lock	Undocumented
Instance Variable	_pointers	list of pointers in this pointer list

Inherited from ModifiableMixIn (via OrderedPointerList, SimplePointerList):

Method	add_submodifiable	Add another modifiable object as a child of this one.
Method	after_flush_or_read	This method should be called after this object has been read and/or flushed to disk. In other words, it should be called at least once whenever this object matches the state of the object on the disk.
Method	dirty.setter	Setter for ModifiableMixIn.dirty
Method	ensure_mutable	If this object is non-mutable, raise an Exception.
Method	get_initial_disk_size	Return the size of this object on disk as it has been read.
Method	get_unmodified_disk_size	Return the size of this object when written to a file before any modifications has been made since the last read/flush.
Method	mark_dirty	Convenience function to mark this object as dirty.
Method	remove_submodifiable	Remove a submodifiable from this object.
Instance Variable	dirty	True if this object or a sub-modifiable has been modified.
Instance Variable	mutable	if not nonzero, prevent modifications of this object.
Instance Variable	_dirty	a boolean flag that's nonzero if this object has been modified
Instance Variable	_old_disk_size	the size of this object on disk before any modifications since the last flush/read
Instance Variable	_submodifiables	a list of child objects, whose dirty state will affect this objects dirty state.