Struct Options

pub struct Options {

    pub align_entries: bool,
    pub align_comments: bool,
    pub align_single_comments: bool,
    pub array_trailing_comma: bool,
    pub array_auto_expand: bool,
    pub inline_table_expand: bool,
    pub array_auto_collapse: bool,
    pub compact_arrays: bool,
    pub compact_inline_tables: bool,
    pub compact_entries: bool,
    pub column_width: usize,
    pub indent_tables: bool,
    pub indent_entries: bool,
    pub indent_string: String,
    pub trailing_newline: bool,
    pub reorder_keys: bool,
    pub reorder_arrays: bool,
    pub allowed_blank_lines: usize,
    pub crlf: bool,
}

All the formatting options.

Fields

align_entries: bool

Align entries vertically.

Entries that have table headers, comments, or blank lines between them are not aligned.

align_comments: bool

Align consecutive comments after entries and items vertically.

This applies to comments that are after entries or array items.

align_single_comments: bool

If align_comments is true, apply the alignment in cases where there’s only one comment.

array_trailing_comma: bool

Put trailing commas for multiline arrays.

array_auto_expand: bool

Automatically expand arrays to multiple lines once they exceed the configured column_width.

inline_table_expand: bool

Expand values (e.g.) inside inline tables where possible.

array_auto_collapse: bool

Automatically collapse arrays if they fit in one line.

The array won’t be collapsed if it contains a comment.

compact_arrays: bool

Omit whitespace padding inside single-line arrays.

compact_inline_tables: bool

Omit whitespace padding inside inline tables.

compact_entries: bool

Omit whitespace around =.

column_width: usize

Target maximum column width after which arrays are expanded into new lines.

This is best-effort and might not be accurate.

indent_tables: bool

Indent subtables if they come in order.

indent_entries: bool

Indent entries under tables.

indent_string: String

Indentation to use, should be tabs or spaces but technically could be anything.

trailing_newline: bool

Add trailing newline to the source.

reorder_keys: bool

Alphabetically reorder keys that are not separated by blank lines.

reorder_arrays: bool

Alphabetically reorder array values that are not separated by blank lines.

allowed_blank_lines: usize

The maximum amount of consecutive blank lines allowed.

crlf: bool

Use CRLF line endings

Implementations

impl Options

pub fn update(&mut self, incomplete: OptionsIncomplete)

pub fn update_camel(&mut self, incomplete: OptionsIncompleteCamel)

pub fn update_from_str<S: AsRef<str>, I: Iterator<Item = (S, S)>>( &mut self, values: I, ) -> Result<(), OptionParseError>

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Options

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Options

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Options

impl StructuralPartialEq for Options