Struct rust_format::PrettyPlease

pub struct PrettyPlease { /* private fields */ }

This is supported on crate feature pretty_please only.

This formatter uses prettyplease for formatting source code

From string:

use rust_format::{Formatter, PrettyPlease};

let source = r#"fn main() { println!("Hello World!"); }"#;

let actual = PrettyPlease::default().format_str(source).unwrap();
let expected = r#"fn main() {
    println!("Hello World!");
}
"#;

assert_eq!(expected, actual);

From token stream:

use quote::quote;
use rust_format::{Formatter, PrettyPlease};

let source = quote! { fn main() { println!("Hello World!"); } };

let actual = PrettyPlease::default().format_tokens(source).unwrap();
let expected = r#"fn main() {
    println!("Hello World!");
}
"#;

assert_eq!(expected, actual);

Implementations

impl PrettyPlease

pub fn new() -> Self

Creates a new instance of PrettyPlease 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 PrettyPlease from the given configuration

Trait Implementations

impl Default for PrettyPlease

fn default() -> PrettyPlease

Returns the “default value” for a type.

impl Formatter for PrettyPlease

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_tokens(&self, tokens: TokenStream) -> Result<String, Error>

This is supported 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

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