Skip to main content

Crate ltk_modpkg

Crate ltk_modpkg 

Source

Re-exports§

pub use error::InvalidSlugError;
pub use error::ModpkgError;

Modules§

builder
error

Structs§

ChunkKey
The identity of a chunk: its path and the layer it belongs to.
ChunkPath
A chunk’s stored path: the authored casing, forward slashes.
DistributorInfo
Information about the distributor site and mod ID.
ExtractionPlan
Every chunk an unpack of a package writes, and where each one lands.
LayerHash
The xxhash3 of a lowercased layer name.
LayerIndex
A position in the package’s layer table.
Modpkg
ModpkgAuthor
The author of a mod package.
ModpkgChunk
A chunk’s table-of-contents record, as stored on disk.
ModpkgDecoder
ModpkgExtractor
Extractor for ModPkg archives.
ModpkgHashtable
One embedded hashtable, as the metadata declares it.
ModpkgLayer
Describes a layer in the mod package.
ModpkgLayerMetadata
Per-layer metadata that can be stored inside the mod package metadata.
ModpkgMetadata
The metadata of a mod package.
PathHash
The xxhash64 of a chunk’s canonical path.
PlannedChunk
One chunk of a package, and where unpacking it puts it.
Slug
A lowercase, hyphen-separated identifier.
WadIndex
A position in the package’s WAD table.
WadNameHash
The xxhash3 of a lowercased WAD name.

Enums§

ChunkDestination
Where one chunk lands when it is unpacked.
ModpkgCompression
The compression type of a chunk.
ModpkgLicense

Constants§

BASE_LAYER_NAME
The name of the base layer.
CURRENT_SCHEMA_VERSION
Current metadata schema version.
HASHES_DIR_NAME
The directory hashtables land under, beside the content.
HASHTABLES_CHUNK_DIR
The chunk directory hashtable chunks are stored under.
LICENSE_CHUNK_PATH
The path to the license text chunk.
METADATA_CHUNK_PATH
The path to the info.msgpack chunk.
METADATA_FOLDER_NAME
The name of the metadata folder inside the mod package.
README_CHUNK_PATH
The path to the README.md chunk.
THUMBNAIL_CHUNK_PATH
The path to the thumbnail chunk.

Functions§

hashtable_file_name
The file name a _meta_/hashes/ chunk lands under, if it is one.

Type Aliases§

BatchChunkEntry
A batch-loaded chunk entry: its key and decompressed data.