Struct Config 

#[non_exhaustive]
pub struct Config {
    pub source_locale: String,
    pub fallback: BTreeMap<String, Vec<String>>,
    pub catalog: CatalogConfig,
    pub locale_data: LocaleDataConfig,
    pub lints: BTreeMap<Lint, Level>,
    pub functions: BTreeMap<String, String>,
}

A corpus’s configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source_locale: String

The locale the manifest and every lint compare against.

fallback: BTreeMap<String, Vec<String>>

Per locale, the locales to take a missing message from, in order. Chains are flattened at build time (D5); the source locale is the implicit last resort.

catalog: CatalogConfig

What the per-locale catalogs carry.

locale_data: LocaleDataConfig

How much CLDR data a catalog carries.

lints: BTreeMap<Lint, Level>

Lint levels, by lint name.

functions: BTreeMap<String, String>

Custom functions for the generated registry: MF2 identifier → the Rust path of a &'static dyn Function.

Implementations

impl Config

pub fn load(dir: &Path) -> Result<Config>

Reads <dir>/mf2.toml, or the defaults if there is none.

pub fn parse(text: &str, path: &Path) -> Result<Config>

Reads a configuration from TOML, naming path in any error.

pub fn to_toml(&self) -> String

Writes the configuration back as TOML (mf2 init).

pub fn level(&self, lint: Lint) -> Level

What lint does in this configuration.

pub fn chain(&self, locale: &str) -> Vec<String>

The fallback chain of locale: the locales to look in after it, in order, ending at the source locale. A locale with no chain of its own falls back to its parent tags (es-MX → es) and then to the source.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Config

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config