Struct ConvertCatalogOptions 

#[non_exhaustive]
pub struct ConvertCatalogOptions<'a> {
    pub content: &'a str,
    pub locale: Option<&'a str>,
    pub source_locale: &'a str,
    pub source_mode: CatalogMode,
    pub target_mode: CatalogMode,
    pub order_by: OrderBy,
    pub po_serialize: SerializeOptions,
}

Available on crate feature catalog only.

Options for converting one in-memory catalog between explicit catalog modes.

The source and target modes are deliberately separate: a mode determines both storage format and semantic interpretation, so callers cannot accidentally ask one format to parse content from another. Conversion preserves the shared message-level PO/FCL model; format-specific PO headers and file-level comments are normalized when the target is FCL.

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.

content: &'a str

Source catalog content.

locale: Option<&'a str>

Optional expected catalog locale.

When the source declares a locale, it must match this value. When the source has no locale, this value is used for the target.

source_locale: &'a str

Source locale used for source-side semantics and FCL header validation.

source_mode: CatalogMode

Mode used to parse the source content.

target_mode: CatalogMode

Mode used to render the target content.

order_by: OrderBy

Sort order for canonical PO output.

FCL always uses its canonical collated (id, ctxt) order.

po_serialize: SerializeOptions

PO serializer controls for target PO output, e.g. width folding.

FCL output has a canonical line shape and ignores these controls.

Implementations

impl<'a> ConvertCatalogOptions<'a>

pub fn new( content: &'a str, source_locale: &'a str, source_mode: CatalogMode, target_mode: CatalogMode, ) -> ConvertCatalogOptions<'a>

Creates in-memory conversion options with explicit source and target modes.

Optional fields default to an inferred locale, msgid ordering, and default PO serialization.

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

Returns options that expect or supply the given catalog locale.

pub fn with_source_mode( self, source_mode: CatalogMode, ) -> ConvertCatalogOptions<'a>

Returns options that parse with the given source mode.

pub fn with_target_mode( self, target_mode: CatalogMode, ) -> ConvertCatalogOptions<'a>

Returns options that render with the given target mode.

pub fn with_order_by(self, order_by: OrderBy) -> ConvertCatalogOptions<'a>

Returns options that render PO output with the given sort order.

pub fn with_po_serialize_options( self, po_serialize: SerializeOptions, ) -> ConvertCatalogOptions<'a>

Returns options that render PO output with the given serializer controls.

Trait Implementations

impl<'a> Clone for ConvertCatalogOptions<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ConvertCatalogOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for ConvertCatalogOptions<'a>

impl<'a> PartialEq for ConvertCatalogOptions<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for ConvertCatalogOptions<'a>