Crate web_static_pack_common

Common crate, containing types shared between web-static-pack and web-static-pack-packer.

For a project documentation, examples, etc. see web-static-pack.

The root type of this crate is pack::Pack. It’s a collection (a hashmap) of files file::File distinguished by pack_path::PackPath (a custom type for path including some sanity checks).

web-static-pack uses rkyv for serialization. Each module provides a rust native type, used during pack building, ex. pack::Pack and rkyv macro-generated zero-copy loadable (aka. mmapable) representation, eg. pack::PackArchived, used by loader.

Note

There are also things called Resolver (eg. pack::PackResolver), that are needed internally by rkyv, but are not used directly in this project. They should be hidden from docs.

Modules

cache_control

Cache control types used by file.

file

File represents single item of a Pack, accessible under specific path.

pack

Pack is the root entity, a collection of files.

pack_path

Pack path contains custom type for representing path inside a pack.

Constants

PACK_FILE_MAGIC

File magic, used by loader to detect if content might not be a pack.

PACK_FILE_VERSION

File version, used by loader to detect if loader and packer versions are compatible.