Skip to main content

Crate ms_pdb_msfz

Crate ms_pdb_msfz 

Source
Expand description

Multi-Stream File - Compressed

This crate allows reading and writing PDZ/MSFZ files. PDZ/MSFZ files are similar to PDB/MSF files. They contain a set of streams, which are indexed by number. Each stream is a sequence of bytes, similar to an ordinary file.

See the MSFZ Container Specification

Structs§

ChunkEntry
Describes one compressed chunk.
Fragment
Describes a region within a stream.
FragmentLocation
Represents the location of a fragment, either compressed or uncompressed.
Msfz
Reads MSFZ files.
MsfzFileHeader
Describes the header at the start of the MSFZ file.
MsfzFinishOptions
Defines options for finishing an MSFZ file.
MsfzWriter
Allows writing a new MSFZ file.
StreamReader
Allows reading a stream using the Read, Seek, and ReadAt traits.
StreamWriter
Allows writing data to a stream.
Summary
Describes the results of writing an MSFZ file.

Enums§

Compression
Specifies the compression algorithms that are supported by this library.
StreamData
Contains the contents of an entire stream.

Constants§

COMPRESSION_DEFLATE
Identifies the Deflate compression algorithm.
COMPRESSION_NONE
Indicates that no compression is used.
COMPRESSION_ZSTD
Identifies the Zstd compression algorithm.
DEFAULT_CHUNK_THRESHOLD
The default threshold for compressing a chunk of data.
MAX_CHUNK_SIZE
The maximum value for the uncompressed chunk size threshold.
MAX_UNCOMPRESSED_FILE_OFFSET
This is the maximum file offset where an uncompressed fragment be be stored.
MIN_CHUNK_SIZE
The minimum value for the uncompressed chunk size threshold.
MIN_FILE_SIZE_16K
This is the minimum file size that is guaranteed to avoid triggering a bug in the first version of the PDZ decoder compiled into DIA (and other MSVC-derived tools).
MSFZ_FILE_SIGNATURE
The signature of a MSFZ/PDZ file.
MSFZ_FILE_VERSION_V0
The current version of the PDZ specification being developed.
NIL_STREAM_SIZE
The special value used for stream size to indicate a nil stream.

Functions§

is_header_msfz
Checks whether the header of a file appears to be a valid MSFZ/PDZ file.