starfuse
Public Member Functions | Public Attributes | List of all members
starfuse.pak.sbbf03.SBBF03 Class Reference
Inheritance diagram for starfuse.pak.sbbf03.SBBF03:
starfuse.fs.mapped_file.MappedFile starfuse.fs.mapped_file.Region starfuse.pak.btreedb4.BTreeDB4 starfuse.pak.pakfile.KeyStore starfuse.pak.pakfile.Package

Public Member Functions

def __init__ (self, path, page_count, read_only=False)
 
def __del__ (self)
 
def block_region (self, bid)
 
def block_count (self)
 
- Public Member Functions inherited from starfuse.fs.mapped_file.MappedFile
def __init__ (self, path, page_count, read_only=False)
 
def __len__ (self)
 
def __del__ (self)
 
def close (self)
 
def region (self, offset, size)
 
def read (self, length=1, offset=-1, advance=True)
 
def write (self, value, offset=-1, length=-1, advance=True)
 
def __getitem__ (self, offset)
 
def __setitem__ (self, offset, value)
 
- Public Member Functions inherited from starfuse.fs.mapped_file.Region
def __init__ (self, parent, base_offset, size)
 
def __len__ (self)
 
def __str__ (self)
 
def __enter__ (self)
 
def __exit__ (self, tipo, value, traceback)
 
def region (self, offset=-1, size=-1)
 
def read (self, length=-1, offset=-1, advance=True)
 
def write (self, value, length=-1, offset=-1, advance=True)
 

Public Attributes

 header
 
 user_header
 
 blocks
 
- Public Attributes inherited from starfuse.fs.mapped_file.MappedFile
 read_only
 
 cursor
 
- Public Attributes inherited from starfuse.fs.mapped_file.Region
 parent
 
 base_offset
 
 cursor
 

Detailed Description

Implements a StarBound block file v3 store that is backed by a file

Can also be used to read in v2.

It's worth noting that the memory regions in this class are mapped and not
read-in.

Member Function Documentation

def starfuse.pak.sbbf03.SBBF03.block_region (   self,
  bid 
)
Gets a block region given the block ID

The documentation for this class was generated from the following file: