web-static-pack-common 0.5.2

Common types for web-static-pack and web-static-pack-packer crates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! Common crate, containing types shared between
//! [web-static-pack](https://crates.io/crates/web-static-pack) and
//! [web-static-pack-packer](https://crates.io/crates/web-static-pack-packer).
//!
//! For a project documentation, examples, etc. see
//! [web-static-pack](https://github.com/peku33/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.

#![warn(missing_docs)]

pub mod cache_control;
pub mod file;
pub mod pack;
pub mod pack_path;

/// File magic, used by loader to detect if content might not be a `pack`.
pub const PACK_FILE_MAGIC: u64 = 0x479a01809f24813c;
/// File version, used by loader to detect if loader and packer versions are
/// compatible.
pub const PACK_FILE_VERSION: u64 = 2;