Struct Rule

pub struct Rule {
    pub name: Option<String>,
    pub include: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
    pub keys: Option<Vec<String>>,
    pub options: Options,
    pub file_rule: Option<GlobRule>,
}

A rule to override options by either name or file.

Fields

name: Option<String>

The name of the rule.

Used in taplo::<name> comments.

include: Option<Vec<String>>

Files this rule is valid for.

A list of Unix-like glob path patterns.

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 that are excluded from this rule.

A list of Unix-like glob path patterns.

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

This has priority over include.

keys: Option<Vec<String>>

Keys the rule is valid for in a document.

A list of Unix-like glob dotted key patterns.

This allows enabling the rule for specific paths in the document.

For example:

• package.metadata will enable the rule for everything inside the package.metadata table, including itself.

If omitted, the rule will always be valid for all keys.

options: Options

file_rule: Option<GlobRule>

Implementations

impl Rule

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

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

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl Default for Rule

fn default() -> Rule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Rule

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 Rule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.