Struct UpdateCatalogFileOptions 

pub struct UpdateCatalogFileOptions<'a> {

    pub target_path: &'a Path,
    pub locale: Option<&'a str>,
    pub source_locale: &'a str,
    pub input: CatalogUpdateInput,
    pub storage_format: CatalogStorageFormat,
    pub semantics: CatalogSemantics,
    pub plural_encoding: PluralEncoding,
    pub obsolete_strategy: ObsoleteStrategy,
    pub overwrite_source_translations: bool,
    pub order_by: OrderBy,
    pub include_origins: bool,
    pub include_line_numbers: bool,
    pub print_placeholders_in_comments: PlaceholderCommentMode,
    pub custom_header_attributes: Option<&'a BTreeMap<String, String>>,
}

Options for updating a catalog file on disk.

Fields

target_path: &'a Path

Path to the catalog file that should be read and conditionally written.

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.

storage_format: CatalogStorageFormat

Storage format used when reading and writing the file content.

semantics: CatalogSemantics

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

plural_encoding: PluralEncoding

Target plural representation for the rendered PO file.

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.

order_by: OrderBy

Sort order for the final rendered catalog.

include_origins: bool

Whether source origins should be rendered as references.

include_line_numbers: bool

Whether rendered references should include line numbers.

print_placeholders_in_comments: PlaceholderCommentMode

Controls emission of placeholder comments.

custom_header_attributes: Option<&'a BTreeMap<String, String>>

Optional additional header attributes to inject or override.

Trait Implementations

impl<'a> Clone for UpdateCatalogFileOptions<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UpdateCatalogFileOptions<'a>

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

Formats the value using the given formatter.

impl Default for UpdateCatalogFileOptions<'_>

fn default() -> UpdateCatalogFileOptions<'_>

Returns the “default value” for a type.

impl<'a> PartialEq for UpdateCatalogFileOptions<'a>

fn eq(&self, other: &UpdateCatalogFileOptions<'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> Eq for UpdateCatalogFileOptions<'a>

impl<'a> StructuralPartialEq for UpdateCatalogFileOptions<'a>