Struct FormatOptions 

#[non_exhaustive]
pub struct FormatOptions {
    pub line_width: usize,
    pub indent_width: usize,
    pub uppercase_keywords: bool,
    pub keyword_case: KeywordCase,
    pub line_ending: LineEnding,
    pub dialect: Dialect,
}

Options controlling formatting. Opinionated and intentionally small.

This type is #[non_exhaustive]: future releases may add knobs without it being a breaking change. Consequently, callers in other crates cannot build it with a struct literal. Start from FormatOptions::default and adjust it through the with_* builder methods instead:

use sql_dialect_fmt_formatter::FormatOptions;
let options = FormatOptions::default()
    .with_line_width(80)
    .with_indent_width(2)
    .with_keyword_case(sql_dialect_fmt_formatter::KeywordCase::Preserve);
assert_eq!(options.line_width, 80);
assert_eq!(options.indent_width, 2);
assert_eq!(options.keyword_case, sql_dialect_fmt_formatter::KeywordCase::Preserve);

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.

line_width: usize

Target line width the printer keeps within where it can.

indent_width: usize

Spaces per indentation level.

uppercase_keywords: bool

Upper-case SQL keywords.

Kept for 1.x source compatibility. New code should use FormatOptions::keyword_case or FormatOptions::with_keyword_case. When this is set to false and keyword_case is still KeywordCase::Upper, the formatter treats it as KeywordCase::Preserve.

keyword_case: KeywordCase

Keyword casing policy.

line_ending: LineEnding

Output line-ending policy.

dialect: Dialect

The SQL dialect to parse and format. Defaults to Dialect::Snowflake.

Implementations

impl FormatOptions

pub fn with_line_width(self, line_width: usize) -> Self

Set the target line width (the column the printer tries to keep lines within), returning the updated options so calls can be chained.

pub fn with_indent_width(self, indent_width: usize) -> Self

Set the number of spaces per indentation level, returning the updated options so calls can be chained.

pub fn with_uppercase_keywords(self, uppercase_keywords: bool) -> Self

Choose whether SQL keywords are upper-cased, returning the updated options so calls can be chained.

pub fn with_keyword_case(self, keyword_case: KeywordCase) -> Self

Choose keyword casing, returning the updated options so calls can be chained.

pub fn with_line_ending(self, line_ending: LineEnding) -> Self

Choose output line endings, returning the updated options so calls can be chained.

pub fn with_dialect(self, dialect: Dialect) -> Self

Set the SQL dialect to parse and format, returning the updated options so calls can be chained.

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() -> Self

Returns the “default value” for a type.