Struct CompileCatalogArtifactOptions 

#[non_exhaustive]
pub struct CompileCatalogArtifactOptions<'a> {
    pub requested_locale: &'a str,
    pub source_locale: &'a str,
    pub fallback_chain: &'a [&'a str],
    pub key_strategy: CompiledKeyStrategy,
    pub source_fallback: bool,
    pub strict_icu: bool,
    pub icu_compatibility: bool,
    pub semantics: CatalogSemantics,
    pub icu_options: CompileCatalogArtifactIcuOptions,
}

Available on crate feature catalog only.

Options controlling high-level compiled catalog artifact generation.

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.

requested_locale: &'a str

Locale for which the runtime artifact should be produced.

source_locale: &'a str

Source locale used for explicit source fallback behavior.

fallback_chain: &'a [&'a str]

Ordered fallback locales consulted after the requested locale.

key_strategy: CompiledKeyStrategy

Built-in strategy used to derive stable runtime keys.

source_fallback: bool

Whether source text should be used when no non-source translation exists.

strict_icu: bool

Whether invalid final ICU messages should fail compilation instead of producing diagnostics.

icu_compatibility: bool

Whether final ICU messages should be checked against source ICU structure.

semantics: CatalogSemantics

High-level semantics used by the input catalog set.

icu_options: CompileCatalogArtifactIcuOptions

ICU-specific options used while validating final runtime messages.

Implementations

impl<'a> CompileCatalogArtifactOptions<'a>

pub fn new( requested_locale: &'a str, source_locale: &'a str, ) -> CompileCatalogArtifactOptions<'a>

Creates artifact compile options with required locales set.

Optional fields default to an empty fallback chain, FerrocatV1 keys, no source fallback, non-strict ICU diagnostics, no ICU compatibility check, and ICU-native semantics.

Examples found in repository

examples/runtime_compile.rs (line 23)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let source = catalog(
        "msgid \"Checkout\"\nmsgstr \"Checkout\"\n\nmsgid \"Cart\"\nmsgstr \"Cart\"\n",
        "en",
    )?;
    let german = catalog("msgid \"Checkout\"\nmsgstr \"Zur Kasse\"\n", "de")?;

    let options = CompileCatalogArtifactOptions::new("de", "en").with_source_fallback(true);
    let artifact = compile_catalog_artifact(&[&source, &german], &options)?;

    assert_eq!(artifact.messages.len(), 2);
    assert_eq!(artifact.missing.len(), 1);
    assert!(artifact.messages.values().any(|value| value == "Zur Kasse"));
    assert!(artifact.messages.values().any(|value| value == "Cart"));

    for (key, value) in &artifact.messages {
        println!("{key} = {value}");
    }

    Ok(())
}

pub fn with_requested_locale( self, requested_locale: &'a str, ) -> CompileCatalogArtifactOptions<'a>

Returns options that compile the given requested locale.

pub fn with_source_locale( self, source_locale: &'a str, ) -> CompileCatalogArtifactOptions<'a>

Returns options that use the given source locale.

pub fn with_fallback_chain( self, fallback_chain: &'a [&'a str], ) -> CompileCatalogArtifactOptions<'a>

Returns options that consult the given ordered fallback locales.

pub fn with_key_strategy( self, key_strategy: CompiledKeyStrategy, ) -> CompileCatalogArtifactOptions<'a>

Returns options that derive runtime keys with the given strategy.

pub fn with_source_fallback( self, source_fallback: bool, ) -> CompileCatalogArtifactOptions<'a>

Returns options that enable or disable source-text fallback.

Examples found in repository

examples/runtime_compile.rs (line 23)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let source = catalog(
        "msgid \"Checkout\"\nmsgstr \"Checkout\"\n\nmsgid \"Cart\"\nmsgstr \"Cart\"\n",
        "en",
    )?;
    let german = catalog("msgid \"Checkout\"\nmsgstr \"Zur Kasse\"\n", "de")?;

    let options = CompileCatalogArtifactOptions::new("de", "en").with_source_fallback(true);
    let artifact = compile_catalog_artifact(&[&source, &german], &options)?;

    assert_eq!(artifact.messages.len(), 2);
    assert_eq!(artifact.missing.len(), 1);
    assert!(artifact.messages.values().any(|value| value == "Zur Kasse"));
    assert!(artifact.messages.values().any(|value| value == "Cart"));

    for (key, value) in &artifact.messages {
        println!("{key} = {value}");
    }

    Ok(())
}

pub fn with_strict_icu( self, strict_icu: bool, ) -> CompileCatalogArtifactOptions<'a>

Returns options that enable or disable hard errors for invalid final ICU messages.

pub fn with_icu_compatibility( self, icu_compatibility: bool, ) -> CompileCatalogArtifactOptions<'a>

Returns options that enable or disable final ICU compatibility checks.

pub fn with_semantics( self, semantics: CatalogSemantics, ) -> CompileCatalogArtifactOptions<'a>

Returns options that interpret input catalogs with the given semantics.

pub fn with_icu_options( self, icu_options: CompileCatalogArtifactIcuOptions, ) -> CompileCatalogArtifactOptions<'a>

Returns options that use the given ICU parser and formatter-support settings.

Trait Implementations

impl<'a> Clone for CompileCatalogArtifactOptions<'a>

fn clone(&self) -> CompileCatalogArtifactOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CompileCatalogArtifactOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for CompileCatalogArtifactOptions<'a>

impl<'a> PartialEq for CompileCatalogArtifactOptions<'a>

fn eq(&self, other: &CompileCatalogArtifactOptions<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for CompileCatalogArtifactOptions<'a>