Struct determinator::rules::DeterminatorRules

pub struct DeterminatorRules {
    pub path_rules: Vec<PathRule>,
    pub package_rules: Vec<PackageRule>,
    /* private fields */
}

Rules for the target determinator.

This forms a configuration file format that can be read from a TOML file.

For more about determinator rules, see the module-level documentation.

Fields

path_rules: Vec<PathRule>

A list of rules that each changed file path is matched against.

package_rules: Vec<PackageRule>

A list of rules that each affected package is matched against.

Sometimes, dependencies between workspace packages aren’t expressed in Cargo.tomls. The packages here act as “virtual dependencies” for the determinator.

Implementations

impl DeterminatorRules

pub fn parse(s: &str) -> Result<Self, Error>

Deserializes determinator rules from the given TOML string.

pub const DEFAULT_RULES_TOML: &'static str = "# These are the default rules shipped with this version of the determinator library. These rules are embedded into the\n# determinator library through `include_str!`.\n#\n# These rules are applied *after* custom rules, so a custom rule that matches any of the same files will override\n# them.\n\n# Standard ignore and other metadata files.\n[[path-rule]]\nglobs = [\"**/.gitignore\", \"**/.gitattributes\", \".dockerignore\", \".hgignore\", \".svnignore\", \"**/.ignore\"]\nmark-changed = []\n\n# Files that can affect the global build. Cargo.toml may contain updates to build flags or profile overrides,\n# so rebuild everything if it changes. (We could do a more sophisticated analysis in the future.)\n[[path-rule]]\nglobs = [\"rust-toolchain\", \"Cargo.toml\", \"**/.cargo/config\", \"**/.cargo/config.toml\"]\nmark-changed = \"all\"\n\n# Tool files that don\'t influence builds or tests.\n[[path-rule]]\nglobs = [\"clippy.toml\", \"rustfmt.toml\", \".lintrules/**/*\"]\nmark-changed = []\n\n# Cargo.lock is ignored, since the determinator does a deeper analysis to figure out which packages changed.\n[[path-rule]]\nglobs = [\"Cargo.lock\"]\nmark-changed = []\n\n# README, LICENSE and other metadata files are ignored throughout the codebase.\n[[path-rule]]\nglobs = [\"**/README*\", \"**/LICENSE*\", \"**/CONTRIBUTING*\", \"**/CODE_OF_CONDUCT*\", \"**/SECURITY*\"]\nmark-changed = []\n"

Contains the default rules in a TOML file format.

The default rules included with this copy of the determinator are:

# These are the default rules shipped with this version of the determinator library. These rules are embedded into the
# determinator library through `include_str!`.
#
# These rules are applied *after* custom rules, so a custom rule that matches any of the same files will override
# them.

# Standard ignore and other metadata files.
[[path-rule]]
globs = ["**/.gitignore", "**/.gitattributes", ".dockerignore", ".hgignore", ".svnignore", "**/.ignore"]
mark-changed = []

# Files that can affect the global build. Cargo.toml may contain updates to build flags or profile overrides,
# so rebuild everything if it changes. (We could do a more sophisticated analysis in the future.)
[[path-rule]]
globs = ["rust-toolchain", "Cargo.toml", "**/.cargo/config", "**/.cargo/config.toml"]
mark-changed = "all"

# Tool files that don't influence builds or tests.
[[path-rule]]
globs = ["clippy.toml", "rustfmt.toml", ".lintrules/**/*"]
mark-changed = []

# Cargo.lock is ignored, since the determinator does a deeper analysis to figure out which packages changed.
[[path-rule]]
globs = ["Cargo.lock"]
mark-changed = []

# README, LICENSE and other metadata files are ignored throughout the codebase.
[[path-rule]]
globs = ["**/README*", "**/LICENSE*", "**/CONTRIBUTING*", "**/CODE_OF_CONDUCT*", "**/SECURITY*"]
mark-changed = []

The latest version of the default rules is available on GitHub.

pub fn default_rules() -> &'static DeterminatorRules

Returns the default rules.

These rules are applied after any custom rules, so they can be overridden by custom rules.

Trait Implementations

impl Clone for DeterminatorRules

fn clone(&self) -> DeterminatorRules

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeterminatorRules

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

Formats the value using the given formatter.

impl Default for DeterminatorRules

The Default impl is the set of custom rules used by the determinator if set_rules isn’t called. It is an empty set of determinator rules, with use_default_rules set to true. This means that if set_rules isn’t called, the only rules in effect are the default ones.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeterminatorRules

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeterminatorRules

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeterminatorRules

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DeterminatorRules

impl StructuralPartialEq for DeterminatorRules