mf2-catalog 2.0.0

The .mf2b binary catalog: a no_std client reader and (features) the writer, the model-rebuilding decoder and the manifest file.
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! `mf2-catalog` — the `.mf2b` binary catalog of Rust MF2: one locale's
//! messages and locale data, as a lossless encoding of the MF2 data model that the client reads in place.
//!
//! An application meets one type of this crate: [`Catalog`], a loaded
//! catalog, which `mf2::leptos` and `mf2::axum` load and serve for it and
//! which [`mf2_runtime`'s formatter](https://docs.rs/mf2-runtime) formats
//! from — with its errors ([`CatalogError`], and on the build side
//! `WriteError` and `ManifestError`). Everything else here is the byte
//! format, which 1.x does not promise (`docs/versioning.md`: rebuild the
//! server and the client together), and is hidden from the documentation:
//!
//! | Part | Feature | Side |
//! |---|---|---|
//! | `Catalog` and its views (`MsgView`, …) — the reader | *(always)* | client: `no_std`, no allocation, no panics, no `core::fmt` |
//! | `number`, `currency`, `unit` — views of the `number.*`, `currency.data` and `unit.data` LOCALE entries (`mf2-fn-number` reads them) | *(always)* | client, same rules |
//! | `Manifest` — `manifest.mf2m` and `manifest_hash` | `manifest` | build |
//! | `writer` — `writer::catalog`, `writer::single` | `writer` | build |
//! | `decode()` — the model-rebuilding decoder (for tests) | `decode` | build |
//! | [`content_hash`] — the hash in a catalog's file name | `content-hash` | build, native |
//!
//! The reader is client-path code: `Catalog::new` takes the fetched buffer
//! and validates its structure once, in linear time; every accessor is a
//! bounds-checked O(1) read that never panics; strings are checked as UTF-8
//! when read; nothing formats. `StrRef` is opaque and loading is one
//! function — the two seams kept for catalog text as JS strings.
//!
//! The byte format is version 1; its constants are in `format`.
//!
//! # The user guide
//!
//! The [Rust MF2 book](https://evancarroll.github.io/rust-mf2/) is the user
//! guide: how the crates fit together, web and native applications, the
//! command line, and what 2.x promises.
//! An application starts at
//! [`mf2`](https://docs.rs/mf2).

#![warn(missing_docs, missing_debug_implementations)]
// docs.rs (`cargo xtask docs-rs`): each feature-gated item says which features it needs.
#![cfg_attr(docsrs, feature(doc_cfg))]
#![no_std]
#![forbid(unsafe_code)]
#![deny(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::indexing_slicing,
    clippy::panic
)]

extern crate alloc;

mod bytes;
#[cfg(feature = "content-hash")]
mod content_hash;
#[doc(hidden)]
pub mod currency;
#[cfg(feature = "decode")]
mod decode;
mod error;
#[doc(hidden)]
pub mod format;
#[cfg(feature = "manifest")]
mod manifest;
mod markup;
#[doc(hidden)]
pub mod number;
mod plural;
mod reader;
#[doc(hidden)]
pub mod unit;
mod view;
#[cfg(feature = "writer")]
#[doc(hidden)]
pub mod writer;

pub use mf2_model::{Dir, MsgId};

#[cfg(feature = "content-hash")]
pub use content_hash::{CONTENT_HASH_LEN, content_hash};
#[cfg(feature = "decode")]
#[doc(hidden)]
pub use decode::{Decoded, decode, decode_report};
pub use error::CatalogError;
#[cfg(feature = "decode")]
#[doc(hidden)]
pub use error::DecodeError;
#[cfg(feature = "manifest")]
pub use error::ManifestError;
#[cfg(feature = "writer")]
pub use error::WriteError;
#[cfg(feature = "manifest")]
#[doc(hidden)]
pub use manifest::Manifest;
#[doc(hidden)]
pub use markup::markup_key;
pub use reader::{Catalog, CldrVersion};
#[doc(hidden)]
pub use reader::{Entry, StrRef};
#[doc(hidden)]
pub use view::{
    Body, DeclView, Declarations, ExprView, FunctionView, KeyView, Keys, Malformed, MarkupView,
    MsgView, Names, Operand, OptionsView, PartView, Parts, PatternView, SelectView, Selectors,
    VarRef, VariantView, Variants,
};