Struct RenderOptions 

#[non_exhaustive]
pub struct RenderOptions<'a> {
    pub order_by: OrderBy,
    pub include_origins: bool,
    pub print_placeholders_in_comments: PlaceholderCommentMode,
    pub custom_header_attributes: Option<&'a BTreeMap<String, String>>,
    pub po_serialize: SerializeOptions,
}

Available on crate feature catalog only.

Shared rendering options for catalog serialization.

These fields control how a catalog is sorted and which optional reference and placeholder details are written. FCL always uses collated (id, ctxt) order because its line order is a storage invariant; order_by controls PO output.

References render the source file only; Ferrocat does not track or emit line numbers (see CatalogOrigin).

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.

order_by: OrderBy

Sort order for the final rendered catalog.

include_origins: bool

Whether source origins should be rendered as references.

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.

po_serialize: SerializeOptions

PO serializer controls for the rendered output, e.g. width folding.

This only affects PO rendering. FCL output has a canonical line shape and ignores these controls. Embedded newline characters always render as valid multiline PO syntax, even with width folding disabled.

Implementations

impl<'a> RenderOptions<'a>

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

Returns options that render messages with the given sort order.

pub fn with_include_origins(self, include_origins: bool) -> RenderOptions<'a>

Returns options that enable or disable rendered source origins.

pub fn with_placeholder_comments( self, print_placeholders_in_comments: PlaceholderCommentMode, ) -> RenderOptions<'a>

Returns options that use the given placeholder comment mode.

pub fn with_custom_header_attributes( self, custom_header_attributes: &'a BTreeMap<String, String>, ) -> RenderOptions<'a>

Returns options that inject or override the given header attributes.

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

Returns options that render PO output with the given serializer controls, e.g. SerializeOptions::default().with_fold_length(0) to disable automatic width folding.

Trait Implementations

impl<'a> Clone for RenderOptions<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RenderOptions<'a>

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

Formats the value using the given formatter.

impl Default for RenderOptions<'_>

fn default() -> RenderOptions<'_>

Returns the “default value” for a type.

impl<'a> Eq for RenderOptions<'a>

impl<'a> PartialEq for RenderOptions<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for RenderOptions<'a>