Crate rustfmt_nightly

Modules

attr 🔒

Format attributes and meta items.

chains 🔒

Formatting of chained expressions, i.e., expressions that are chained by dots: struct and enum field access, method calls, and try shorthand (?).

closures 🔒

comment 🔒

config 🔒

coverage 🔒

emitter 🔒

expr 🔒

format_report_formatter 🔒

formatting 🔒

ignore_path 🔒

imports 🔒

items 🔒

lists 🔒

Format list-like expressions and items.

macros 🔒

matches 🔒

Format match expression.

missed_spans 🔒

modules 🔒

overflow 🔒

Rewrite a list some items with overflow.

pairs 🔒

parse 🔒

patterns 🔒

release_channel 🔒

reorder 🔒

Reorder items.

rewrite 🔒

rustfmt_diff 🔒

shape 🔒

skip 🔒

Module that contains skip related stuffs.

source_file 🔒

source_map 🔒

This module contains utilities that work with the SourceMap from libsyntax/syntex_syntax. This includes extension traits and methods for looking up spans and line ranges for AST nodes.

spanned 🔒

stmt 🔒

string 🔒

types 🔒

utils 🔒

vertical 🔒

visitor 🔒

Macros

is_nightly_channel

Checks if we’re in a nightly build.

Structs

Config

FileLines

A set of lines in files.

FormatReport

Reports on any issues that occurred during a run of Rustfmt.

FormatReportFormatter

Formats the warnings/errors in a FormatReport.

FormatReportFormatterBuilder

A builder for FormatReportFormatter.

FormattedSnippet 🔒

Result of formatting a snippet of code along with ranges of lines that didn’t get formatted, i.e., that got returned as they were originally.

ModifiedChunk

A single span of changed lines, with 0 or more removed lines and a vector of 0 or more inserted lines.

ModifiedLines

Set of changed sections of a file.

Range

A range that is inclusive of both ends.

Session

A session is a run of rustfmt across a single or multiple inputs.

Enums

Color

Edition

EmitMode

ErrorKind

The various errors that can occur during formatting. Note that not all of these can currently be propagated to clients.

FileName

Defines the name of an input - either a file or stdin.

Input

NewlineStyle

Verbosity

Traits

CliOptions

Maps client-supplied options to Rustfmt’s internals, mostly overriding values in a config with values from the command line.

Functions

create_emitter 🔒

format_code_block 🔒

Format the given code block. Mainly targeted for code block in comment. The code block may be incomplete (i.e., parser may be unable to parse it). To avoid panic in parser, we wrap the code block with a dummy function. The returned code block does not end with newline.

format_snippet 🔒

Format the given snippet. The snippet is expected to be complete code. When we cannot parse the given snippet, this function returns None.

load_config

Loads a config by checking the client-supplied options and if appropriate, the file system (including searching the file system for overrides).