Enum FormatIntent 

pub enum FormatIntent {
    Indent,
    Reflow,
    Reformat,
}

Which of the three formatting jobs a range wants done.

Separate values rather than one “format”, because they are not substitutable and the failure directions differ: an indent that reflows is destructive, a reformatter asked to reflow prose mostly does nothing at all. docs/dev/architecture/text-reflow.md §2 has the table.

Each intent names one ProviderChain option (format.indent / format.reflow / format.reformat) and one or more verbs.

Variants

Indent

Leading whitespace only — =.

Reflow

Line breaks within a paragraph — gq / gw.

Reformat

Anything the formatter likes — :format, g=, format-on-save.

Implementations

impl FormatIntent

pub fn label(self) -> &'static str

Canonical string label.

pub fn doc(self) -> &'static str

Short marginalia doc shown in cmdline-completion’s right-aligned column.

pub fn all() -> &'static [Self]

Variants in declaration order.

pub fn parse_label(s: &str) -> Result<Self, String>

Parse from canonical label or any registered alias.

Trait Implementations

impl Clone for FormatIntent

fn clone(&self) -> FormatIntent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FormatIntent

impl Debug for FormatIntent

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

Formats the value using the given formatter.

impl Default for FormatIntent

fn default() -> FormatIntent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FormatIntent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FormatIntent

impl PartialEq for FormatIntent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FormatIntent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FormatIntent