determinator::rules

Struct DeterminatorRules

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

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§

source§

impl DeterminatorRules

source

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.

source

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

Deserializes determinator rules from the given TOML string.

source

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§

source§

impl Clone for DeterminatorRules

source§

fn clone(&self) -> DeterminatorRules

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
source§

impl Debug for DeterminatorRules

source§

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

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

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.

source§

fn default() -> Self

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

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq for DeterminatorRules

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for DeterminatorRules

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for DeterminatorRules

source§

impl StructuralPartialEq for DeterminatorRules

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, dst: *mut T)

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,