Struct FormatOptions 

pub struct FormatOptions { /* private fields */ }

Formatter behavior switches.

Prefer Default, FormatOptions::new, or the with_* helpers when constructing options so new fields can ship with defaults without breaking call sites.

Examples

use daml_fmt::{FormatOptions, ImportOrder};

let from_default = FormatOptions::default();
let preserved = FormatOptions::new().with_import_order(ImportOrder::Preserve);

assert_eq!(preserved.import_order(), ImportOrder::Preserve);
assert_ne!(from_default.import_order(), preserved.import_order());

Implementations

impl FormatOptions

pub const fn new() -> Self

Create formatter options with the default organizing configuration.

This is equivalent to Default::default and currently uses ImportOrder::Organize.

pub const fn import_order(self) -> ImportOrder

How the formatter handles import declarations.

• ImportOrder::Organize groups/sorts imports into canonical formatter order.
• ImportOrder::Preserve keeps original declaration order.

Reordering imports can change package identity even when the source-level declarations denote the same imports; use --preserve-import-order in the CLI when package identity stability matters more than import organization.

pub const fn rules(self) -> FormatRuleSet

Formatter rules enabled for this formatting run.

pub const fn with_rules(self, rules: FormatRuleSet) -> Self

Set the formatter rules enabled for this formatting run.

pub const fn with_import_order(self, import_order: ImportOrder) -> Self

Set the import ordering strategy.

See FormatOptions::import_order for the package-identity warning when imports are reordered.

Trait Implementations

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FormatOptions

impl Debug for FormatOptions

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

Formats the value using the given formatter.

impl Default for FormatOptions

fn default() -> FormatOptions

Returns the “default value” for a type.

impl Eq for FormatOptions

impl PartialEq for FormatOptions

fn eq(&self, other: &FormatOptions) -> 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 StructuralPartialEq for FormatOptions