Struct RuleSet

Source
pub struct RuleSet { /* private fields */ }
Expand description

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§

Source§

impl RuleSet

Source

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

Construct a RuleSet from a Vec of Rules.

Source

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.

Source

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.

Source

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§

Source§

impl Clone for RuleSet

Source§

fn clone(&self) -> RuleSet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> 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.