Struct UpdateCatalogOptions 

#[non_exhaustive]
pub struct UpdateCatalogOptions<'a> {
    pub locale: Option<&'a str>,
    pub source_locale: &'a str,
    pub input: CatalogUpdateInput,
    pub existing: Option<&'a str>,
    pub mode: CatalogMode,
    pub obsolete_strategy: ObsoleteStrategy,
    pub overwrite_source_translations: bool,
    pub now: Option<&'a str>,
    pub render: RenderOptions<'a>,
}

Available on crate feature catalog only.

Options for in-memory catalog updates.

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.

locale: Option<&'a str>

Locale of the catalog being updated. When None, Ferrocat infers it from the existing file.

source_locale: &'a str

Source locale used for source-side semantics and fallback handling.

input: CatalogUpdateInput

Extracted messages to merge into the catalog.

existing: Option<&'a str>

Existing catalog content, when updating an in-memory catalog.

mode: CatalogMode

High-level catalog mode used when parsing, merging, and rendering the catalog.

obsolete_strategy: ObsoleteStrategy

Strategy for messages absent from the extracted input.

overwrite_source_translations: bool

Whether source-locale translations should be refreshed from the extracted source strings.

now: Option<&'a str>

Optional host-provided clock as an ISO-8601 date. When set, entries newly transitioning to obsolete are stamped with this since date (write-once). Ferrocat never reads a clock itself, so updates stay deterministic given their inputs. See ADR 0025.

render: RenderOptions<'a>

Shared serialization options for the rendered catalog.

Implementations

impl<'a> UpdateCatalogOptions<'a>

pub fn new( source_locale: &'a str, input: impl Into<CatalogUpdateInput>, ) -> UpdateCatalogOptions<'a>

Creates in-memory update options with required fields set.

Optional fields default to an inferred locale, ICU-native PO mode, marking missing messages obsolete, preserving source-locale translations, no host clock, and RenderOptions::default.

Examples found in repository

crates/ferrocat/examples/fcl_with_mt_metadata.rs (line 18)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let hash = machine_translation_hash(EffectiveTranslationRef::Singular("Hallo"));
    let existing = format!(
        "%FCL1\tsource=en\tlocale=de\nHello\t\tHallo\tlock={hash}\tai=example/mt:0.92\n",
        hash = hash
    );

    let input = CatalogUpdateInput::SourceFirst(vec![SourceExtractedMessage {
        msgid: "Hello".to_owned(),
        ..SourceExtractedMessage::default()
    }]);
    let result = update_catalog(
        UpdateCatalogOptions::new("en", input)
            .with_locale("de")
            .with_mode(CatalogMode::IcuFcl)
            .with_existing(&existing),
    )?;

    assert!(result.content.starts_with("%FCL1"));
    assert!(result.content.contains("ai=example/mt:0.92"));
    assert!(result.content.contains(&hash));

    println!("{}", result.content);
    Ok(())
}

pub fn with_locale(self, locale: &'a str) -> UpdateCatalogOptions<'a>

Returns options that use the given catalog locale.

Examples found in repository

crates/ferrocat/examples/fcl_with_mt_metadata.rs (line 19)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let hash = machine_translation_hash(EffectiveTranslationRef::Singular("Hallo"));
    let existing = format!(
        "%FCL1\tsource=en\tlocale=de\nHello\t\tHallo\tlock={hash}\tai=example/mt:0.92\n",
        hash = hash
    );

    let input = CatalogUpdateInput::SourceFirst(vec![SourceExtractedMessage {
        msgid: "Hello".to_owned(),
        ..SourceExtractedMessage::default()
    }]);
    let result = update_catalog(
        UpdateCatalogOptions::new("en", input)
            .with_locale("de")
            .with_mode(CatalogMode::IcuFcl)
            .with_existing(&existing),
    )?;

    assert!(result.content.starts_with("%FCL1"));
    assert!(result.content.contains("ai=example/mt:0.92"));
    assert!(result.content.contains(&hash));

    println!("{}", result.content);
    Ok(())
}

pub fn with_existing(self, existing: &'a str) -> UpdateCatalogOptions<'a>

Returns options that update the given existing catalog content.

Examples found in repository

crates/ferrocat/examples/fcl_with_mt_metadata.rs (line 21)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let hash = machine_translation_hash(EffectiveTranslationRef::Singular("Hallo"));
    let existing = format!(
        "%FCL1\tsource=en\tlocale=de\nHello\t\tHallo\tlock={hash}\tai=example/mt:0.92\n",
        hash = hash
    );

    let input = CatalogUpdateInput::SourceFirst(vec![SourceExtractedMessage {
        msgid: "Hello".to_owned(),
        ..SourceExtractedMessage::default()
    }]);
    let result = update_catalog(
        UpdateCatalogOptions::new("en", input)
            .with_locale("de")
            .with_mode(CatalogMode::IcuFcl)
            .with_existing(&existing),
    )?;

    assert!(result.content.starts_with("%FCL1"));
    assert!(result.content.contains("ai=example/mt:0.92"));
    assert!(result.content.contains(&hash));

    println!("{}", result.content);
    Ok(())
}

pub fn with_mode(self, mode: CatalogMode) -> UpdateCatalogOptions<'a>

Returns options that parse, merge, and render with the given catalog mode.

Examples found in repository

crates/ferrocat/examples/fcl_with_mt_metadata.rs (line 20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let hash = machine_translation_hash(EffectiveTranslationRef::Singular("Hallo"));
    let existing = format!(
        "%FCL1\tsource=en\tlocale=de\nHello\t\tHallo\tlock={hash}\tai=example/mt:0.92\n",
        hash = hash
    );

    let input = CatalogUpdateInput::SourceFirst(vec![SourceExtractedMessage {
        msgid: "Hello".to_owned(),
        ..SourceExtractedMessage::default()
    }]);
    let result = update_catalog(
        UpdateCatalogOptions::new("en", input)
            .with_locale("de")
            .with_mode(CatalogMode::IcuFcl)
            .with_existing(&existing),
    )?;

    assert!(result.content.starts_with("%FCL1"));
    assert!(result.content.contains("ai=example/mt:0.92"));
    assert!(result.content.contains(&hash));

    println!("{}", result.content);
    Ok(())
}

pub fn with_render(self, render: RenderOptions<'a>) -> UpdateCatalogOptions<'a>

Returns options that render the updated catalog with the given options.

pub fn with_obsolete_strategy( self, obsolete_strategy: ObsoleteStrategy, ) -> UpdateCatalogOptions<'a>

Returns options that handle missing extracted messages with the given strategy.

pub fn with_overwrite_source_translations( self, overwrite_source_translations: bool, ) -> UpdateCatalogOptions<'a>

Returns options that enable or disable source-locale translation refreshes.

pub fn with_now(self, now: &'a str) -> UpdateCatalogOptions<'a>

Returns options that stamp newly obsolete entries with the given ISO date.

Trait Implementations

impl<'a> Clone for UpdateCatalogOptions<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateCatalogOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for UpdateCatalogOptions<'a>

impl<'a> PartialEq for UpdateCatalogOptions<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for UpdateCatalogOptions<'a>