Struct rust_format::Config

source · [−]

pub struct Config<K, P, V> where
    K: Eq + Hash + AsRef<OsStr>,
    P: Into<PathBuf>,
    V: AsRef<OsStr>,  { /* private fields */ }

Expand description

The configuration for the formatters. Most of the options are for rustfmt only (they are ignored by PrettyPlease, but PostProcess options are used by both formatters).

Implementations

impl<'a, 'b> Config<&'a str, &'b str, &'a str>

pub fn new_str() -> Self

Creates a new blank configuration with &str for all type params (if you wish to use different types, use new instead)

pub fn from_hash_map_str(options: HashMap<&'a str, &'a str>) -> Self

Creates a new configuration from the given HashMap of options using &str for all type params (if you wish to use different types, use from_hash_map instead)

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

pub fn new() -> Self

Creates a new blank configuration without type parameter assumptions

pub fn from_hash_map(options: HashMap<K, V>) -> Self

Creates a new configuration from the given HashMap of options with no type assumptions

pub fn rust_fmt_path(self, path: P) -> Self

Set the path to the rustfmt binary to use (RustFmt only, ignored by PrettyPlease). This takes precedence over the RUSTFMT environment variable, if specified

pub fn edition(self, edition: Edition) -> Self

Set the Rust edition of the source input (RustFmt only, ignored by PrettyPlease)

pub fn post_proc(self, post_proc: PostProcess) -> Self

Set the post processing option after formatting (used by both RustFmt and PrettyPlease)

pub fn option(self, key: K, value: V) -> Self

Set a key/value pair option (RustFmt only, ignored by PrettyPlease). See here for a list of possible options

Trait Implementations

impl<K: Clone, P: Clone, V: Clone> Clone for Config<K, P, V> where
    K: Eq + Hash + AsRef<OsStr>,
    P: Into<PathBuf>,
    V: AsRef<OsStr>,

fn clone(&self) -> Config<K, P, V>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<K: Debug, P: Debug, V: Debug> Debug for Config<K, P, V> where
    K: Eq + Hash + AsRef<OsStr>,
    P: Into<PathBuf>,
    V: AsRef<OsStr>,

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

Formats the value using the given formatter. Read more

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

fn default() -> Config<K, P, V>

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

Auto Trait Implementations

impl<K, P, V> RefUnwindSafe for Config<K, P, V> where
    K: RefUnwindSafe,
    P: RefUnwindSafe,
    V: RefUnwindSafe,

impl<K, P, V> Send for Config<K, P, V> where
    K: Send,
    P: Send,
    V: Send,

impl<K, P, V> Sync for Config<K, P, V> where
    K: Sync,
    P: Sync,
    V: Sync,

impl<K, P, V> Unpin for Config<K, P, V> where
    K: Unpin,
    P: Unpin,
    V: Unpin,

impl<K, P, V> UnwindSafe for Config<K, P, V> where
    K: UnwindSafe,
    P: UnwindSafe,
    V: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.