Struct RustFmt

pub struct RustFmt { /* private fields */ }

This formatter uses rustfmt for formatting source code

An example using a custom configuration:

use rust_format::{Config, Edition, Formatter, RustFmt};

let source = r#"use std::marker; use std::io; mod test; mod impls;"#;

let mut config = Config::new_str()
    .edition(Edition::Rust2018)
    .option("reorder_imports", "false")
    .option("reorder_modules", "false");
let rustfmt = RustFmt::from_config(config);

let actual = rustfmt.format_str(source).unwrap();
let expected = r#"use std::marker;
use std::io;
mod test;
mod impls;
"#;

assert_eq!(expected, actual);

Implementations

impl RustFmt

pub fn new() -> Self

Creates a new instance of RustFmt using a default configuration

pub fn from_config<K, P, V>(config: Config<K, P, V>) -> Self

where K: Default + Eq + Hash + AsRef<OsStr>, P: Default + Into<PathBuf>, V: Default + AsRef<OsStr>,

Creates a new instance of the formatter from the given configuration

Trait Implementations

impl Clone for RustFmt

fn clone(&self) -> RustFmt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RustFmt

fn default() -> Self

Returns the “default value” for a type.

impl Formatter for RustFmt

fn format_str(&self, source: impl AsRef<str>) -> Result<String, Error>

Format the given string and return the results in another String. An error is returned if any issues occur during formatting

fn format_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Format the given file specified hte path and overwrite the file with the results. An error is returned if any issues occur during formatting

fn format_tokens(&self, tokens: TokenStream) -> Result<String, Error>

Available on crate feature token_stream only.

Format the given TokenStream and return the results in a String. An error is returned if any issues occur during formatting