MSFFormat (msf_format v0.1.0)
Describes the MSF file format and functions for deserializing it from binary or file inputs.
Link to this section Summary
Functions
Close the underlying IO device for the given MSF file.
Open and read the MSF file at the given path.
Open a stream for reading. Call MSFFormat.Stream.read to read blocks from the stream in sequence.
Read an MSF file from the given device. Does not read the entire file, only the data required to read specific blocks.
Attempt to read the block at the given index from the given MSF file. If a size
parameter is given, the
specified number of bytes will be read, otherwise the entire contents of the block will be read.
Link to this section Functions
close(msf_format)
Close the underlying IO device for the given MSF file.
open(path)
Open and read the MSF file at the given path.
open_stream(msf, stream_id)
Open a stream for reading. Call MSFFormat.Stream.read to read blocks from the stream in sequence.
read(device)
Read an MSF file from the given device. Does not read the entire file, only the data required to read specific blocks.
read_block(msf, index)
Attempt to read the block at the given index from the given MSF file. If a size
parameter is given, the
specified number of bytes will be read, otherwise the entire contents of the block will be read.