Struct RuleSet

pub struct RuleSet { /* private fields */ }

RuleSet is a collection of CODEOWNERS rules that can be matched together against a given path. It is constructed by passing a Vec of Rule structs to RuleSet::new. For convenience, RuleSet::from_reader can be used to parse a CODEOWNERS file and construct a RuleSet from it.

Example

use codeowners_rs::{RuleSet, parse};

let ruleset = parse("*.rs rustacean@example.com").into_ruleset();
assert_eq!(format!("{:?}", ruleset.owners("main.rs")), "Some([Owner { value: \"rustacean@example.com\", kind: Email }])");

Implementations

impl RuleSet

pub fn new(rules: Vec<Rule>) -> Self

Construct a RuleSet from a Vec of Rules.

pub fn matching_rule(&self, path: impl AsRef<Path>) -> Option<&Rule>

Returns the matching rule (if any) for the given path. If multiple rules match the path, the last matching rule in the CODEOWNERS file will be returned. If no rules match the path, None will be returned.

pub fn owners(&self, path: impl AsRef<Path>) -> Option<&[Owner]>

Returns the owners for the given path, or None if no rules match the path or the matching rule has no owners.

pub fn all_matching_rules(&self, path: impl AsRef<Path>) -> Vec<(usize, &Rule)>

Returns the all rules that match the given path along with their indices. If multiple rules match the path, the rule with the highest index should be considered to be the “winning” rule.

Trait Implementations

impl Clone for RuleSet

fn clone(&self) -> RuleSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.