pyvista_zstd.ZstdFileMetadata

class pyvista_zstd.ZstdFileMetadata(frame_names: list[str], compression_level: int, compression: Literal['zstandard', 'lz4'] = 'zstandard', file_version: int = 0)

File-level facts of a pyvista-zstd container.

Returned by pyvista_zstd.Reader.file_metadata. The attributes are the supported interface; the JSON and array conversions serve the file format.

Attributes:

frame_nameslist[str]

Stored name of every array and dataset-metadata document, in file order; the file-metadata document itself is not listed. Each name starts with the 16-character identifier of its dataset.

compression_levelint

Zstandard level the file was written with.

compressionstr

Compression algorithm, "zstandard".

file_versionint

On-disk format version.

Methods

from_json(s)	Create from JSON.
to_array()	Output as a numpy uint8 array.
to_json()	Convert to JSON.

Methods

ZstdFileMetadata.__init__(frame_names, ...)
ZstdFileMetadata.from_json(s)	Create from JSON.
ZstdFileMetadata.to_array()	Output as a numpy uint8 array.
ZstdFileMetadata.to_json()	Convert to JSON.

Attributes

ZstdFileMetadata.frame_names
ZstdFileMetadata.compression_level
ZstdFileMetadata.compression
ZstdFileMetadata.file_version