Skip to main content

FormatterDefinition

Struct FormatterDefinition 

Source
pub struct FormatterDefinition {
    pub preset: Option<String>,
    pub cmd: Option<String>,
    pub args: Option<Vec<String>>,
    pub prepend_args: Option<Vec<String>>,
    pub append_args: Option<Vec<String>>,
    pub stdin: Option<bool>,
    pub enabled: Option<bool>,
}
Expand description

NEW: Named formatter definition (formatters.NAME sections in new format) OLD: Language-specific formatter config (formatters.LANG sections in old format)

In new format, if the definition name matches a built-in preset, unspecified fields will inherit from that preset. This allows partial overrides like:

[formatters.air]
args = ["format", "--custom"]  # Overrides args, inherits cmd/stdin from built-in "air"

Additionally, you can modify arguments incrementally using prepend-args and append-args:

[formatters.air]
append-args = ["-i", "2"]  # Adds args to end: ["format", "{}", "-i", "2"]

Fields§

§preset: Option<String>

Reference to a built-in preset (e.g., “air”, “black”) - OLD FORMAT ONLY In new format, presets are referenced directly in [formatters] mapping

§cmd: Option<String>

Custom command to execute (None = inherit from preset if name matches)

§args: Option<Vec<String>>

Arguments to pass (None = inherit from preset if name matches)

§prepend_args: Option<Vec<String>>

Arguments to prepend to base args (from preset or explicit args)

§append_args: Option<Vec<String>>

Arguments to append to base args (from preset or explicit args)

§stdin: Option<bool>

Whether the formatter reads from stdin (None = inherit from preset if name matches)

§enabled: Option<bool>

DEPRECATED: Whether formatter is enabled (old format only)

Trait Implementations§

Source§

impl Clone for FormatterDefinition

Source§

fn clone(&self) -> FormatterDefinition

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 Debug for FormatterDefinition

Source§

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

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

impl Default for FormatterDefinition

Source§

fn default() -> FormatterDefinition

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

impl<'de> Deserialize<'de> for FormatterDefinition

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for FormatterDefinition

Source§

fn eq(&self, other: &FormatterDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FormatterDefinition

Auto Trait Implementations§

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,