Struct ScriptFormatConfig

#[non_exhaustive]
pub struct ScriptFormatConfig {
    pub margin: u16,
    pub inline: u16,
    pub indent: u16,
    pub preserve_expr_groups: bool,
    pub preserve_blank_lines: bool,
    pub preserve_blocks: bool,
    pub compact_blocks: bool,
}

Configuration options for the Ad Astra script formatting utility.

Used as an argument for the format_script_text and ModuleText::format functions.

The Default implementation of this object provides canonical configuration options, though you can customize some formatting options at your discretion.

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.

margin: u16

The number of characters the formatter should keep in a line before breaking the content into multiple lines.

The default value is 80.

inline: u16

If the formatter breaks a line into multiple lines, it should attempt to keep at least the inline number of characters in each line, relative to the current indentation.

The default value is 60.

indent: u16

The number of whitespace characters for a single level of indentation.

The default value is 4.

preserve_expr_groups: bool

If set to true, the formatter preserves excessive parentheses in expressions.

For example, the formatter will keep the expression (1 + 2) + 3 as it is, even though it could otherwise be rewritten as 1 + 2 + 3.

The default value is false, meaning that the formatter will attempt to remove unnecessary parentheses whenever possible.

preserve_blank_lines: bool

If set to true, the formatter preserves at most one blank line between script code statements. Otherwise, the formatter will eliminate excessive blank lines.

The default value is true.

preserve_blocks: bool

If set to true, the formatter preserves statement blocks even if they could clearly be merged into the surrounding code.

For example, the formatter will keep the code foo(); { bar(); } baz(); as it is, even though it could otherwise be rewritten as foo(); bar(); baz();.

The default value is false, meaning that the formatter will attempt to merge blocks together.

compact_blocks: bool

When set to true, the formatter attempts to keep short code blocks in line.

For example, the formatter will keep the code { foo(); } in line instead of breaking it into three lines:

{
    foo();
}

The default value is false, meaning that the formatter will typically break single-statement blocks into multiple lines.

Implementations

impl ScriptFormatConfig

pub const fn new() -> Self

The default constructor for the configuration.

Trait Implementations

impl Clone for ScriptFormatConfig

fn clone(&self) -> ScriptFormatConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptFormatConfig

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

Formats the value using the given formatter.

impl Default for ScriptFormatConfig

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ScriptFormatConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScriptFormatConfig

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

impl Eq for ScriptFormatConfig

impl StructuralPartialEq for ScriptFormatConfig