Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 20 fields pub root: PathBuf, pub manifest_path: PathBuf, pub locales_dir: PathBuf, pub locales: Vec<String>, pub reference_locale: String, pub src: Vec<PathBuf>, pub templates: Vec<PathBuf>, pub template_ext: Vec<String>, pub filters: Vec<String>, pub functions: Vec<String>, pub unused: Severity, pub ignore_unused: Vec<String>, pub attributes: bool, pub include_comments: bool, pub require_locales: bool, pub exclude: Vec<String>, pub follow_links: bool, pub format: OutputFormat, pub color: ColorChoice, pub quiet: bool,
}
Expand description

A fully resolved configuration. Every path is absolute.

Fields§

§root: PathBuf

The directory being linted. Paths in the report are relative to it.

§manifest_path: PathBuf

The root Cargo.toml.

§locales_dir: PathBuf

Directory holding one subdirectory per locale.

§locales: Vec<String>

Locales to check, sorted.

§reference_locale: String

Locale the unused-key check runs against.

§src: Vec<PathBuf>

Rust source directories to scan.

§templates: Vec<PathBuf>

Template directories to scan.

§template_ext: Vec<String>

Template file extensions, lowercase and without a leading dot.

§filters: Vec<String>

Askama filter names that take a key.

§functions: Vec<String>

Rust function names that take a key.

§unused: Severity

Severity for the unused-key check.

§ignore_unused: Vec<String>

Key-name globs never reported as unused.

§attributes: bool

Whether key.attribute counts as a defined key.

§include_comments: bool

Whether to match keys inside // comment lines.

§require_locales: bool

Whether a missing or empty locales directory is an error.

§exclude: Vec<String>

Path globs to skip, relative to the root.

§follow_links: bool

Whether to follow symbolic links while walking.

§format: OutputFormat

Shape of the rendered report.

§color: ColorChoice

When to emit color.

§quiet: bool

Whether to stay silent when there is nothing to report.

Implementations§

Source§

impl Config

Source

pub fn relative(&self, path: &Path) -> PathBuf

Makes path relative to the root.

Source

pub fn is_template_ext(&self, ext: &str) -> bool

Whether ext is one of the configured template extensions.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Config

Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.