FormatOptions

Struct FormatOptions 

Source
pub struct FormatOptions<'a> {
    pub indent: Indent,
    pub uppercase: Option<bool>,
    pub lines_between_queries: u8,
    pub ignore_case_convert: Option<Vec<&'a str>>,
    pub inline: bool,
    pub max_inline_block: usize,
    pub max_inline_arguments: Option<usize>,
    pub max_inline_top_level: Option<usize>,
    pub joins_as_top_level: bool,
    pub dialect: Dialect,
}
Expand description

Options for controlling how the library formats SQL

Fields§

§indent: Indent

Controls the type and length of indentation to use

Default: 2 spaces

§uppercase: Option<bool>

When set, changes reserved keywords to ALL CAPS

Default: false

§lines_between_queries: u8

Controls the number of line breaks after a query

Default: 1

§ignore_case_convert: Option<Vec<&'a str>>

Ignore case conversion for specified strings in the array.

Default: None

§inline: bool

Keep the query in a single line

Default: false

§max_inline_block: usize

Maximum length of an inline block

Default: 50

§max_inline_arguments: Option<usize>

Maximum length of inline arguments

If unset keep every argument in a separate line

Default: None

§max_inline_top_level: Option<usize>

Inline the argument at the top level if they would fit a line of this length

Default: None

§joins_as_top_level: bool

Consider any JOIN statement as a top level keyword instead of a reserved keyword

Default: false,

§dialect: Dialect

Tell the SQL dialect to use

Default: Generic

Trait Implementations§

Source§

impl<'a> Clone for FormatOptions<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for FormatOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for FormatOptions<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for FormatOptions<'a>

§

impl<'a> RefUnwindSafe for FormatOptions<'a>

§

impl<'a> Send for FormatOptions<'a>

§

impl<'a> Sync for FormatOptions<'a>

§

impl<'a> Unpin for FormatOptions<'a>

§

impl<'a> UnwindSafe for FormatOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.