Struct Config

pub struct Config {
    pub include: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
    pub rule: Vec<Rule>,
    pub global_options: Options,
    pub file_rule: Option<GlobRule>,
    pub plugins: Option<HashMap<String, Plugin>>,
}

Fields

include: Option<Vec<String>>

Files to include.

A list of Unix-like glob path patterns. Globstars (**) are supported.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

Omitting this property includes all files, however an empty array will include none.

exclude: Option<Vec<String>>

Files to exclude (ignore).

A list of Unix-like glob path patterns. Globstars (**) are supported.

Relative paths are not relative to the configuration file, but rather depends on the tool using the configuration.

This has priority over include.

rule: Vec<Rule>

Rules are used to override configurations by path and keys.

global_options: Options

file_rule: Option<GlobRule>

plugins: Option<HashMap<String, Plugin>>

Implementations

impl Config

pub fn prepare( &mut self, e: &impl Environment, base: &Path, ) -> Result<(), Error>

Prepare the configuration for further use.

pub fn is_included(&self, path: &Path) -> bool

pub fn rules_for<'r>( &'r self, path: &'r Path, ) -> impl DoubleEndedIterator<Item = &'r Rule> + Clone + 'r

pub fn update_format_options(&self, path: &Path, options: &mut Options)

pub fn format_scopes<'s>( &'s self, path: &'s Path, ) -> impl Iterator<Item = (&'s String, OptionsIncomplete)> + Clone + 's

pub fn is_schema_enabled(&self, path: &Path) -> bool

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Config

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.