Struct CodeOwners 

pub struct CodeOwners { /* private fields */ }

A parsed CODEOWNERS file.

Implementations

impl CodeOwners

pub fn parse(text: &str) -> Self

Parse a CODEOWNERS file. Never fails; invalid lines are collected in errors, matching GitHub’s own behaviour.

pub fn of(&self, path: &str) -> Option<&[Owner]>

Owners of path, or None if no rule matched.

Some(&[]) means a rule matched and explicitly left the path unowned. That distinction is the whole point; see the crate docs.

pub fn rule_for(&self, path: &str) -> Option<&Rule>

The rule that decides path — the last matching rule in the file.

pub fn all_matching(&self, path: &str) -> Vec<&Rule>

Every rule that matches path, in file order.

Only the last one takes effect, but a linter wants to show the rest.

pub fn shadowed(&self) -> Vec<&Rule>

Rules that can never take effect, because a later rule always wins for everything they match.

A cheap, useful lint: it catches the classic mistake of putting a specific rule above the catch-all instead of below it.

pub fn rules(&self) -> &[Rule]

All rules, in file order.

pub fn errors(&self) -> &[ParseError]

Lines that were skipped.

pub fn is_empty(&self) -> bool

True if no rule parsed successfully.

Trait Implementations

impl Clone for CodeOwners

fn clone(&self) -> CodeOwners

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeOwners

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

Formats the value using the given formatter.

impl Default for CodeOwners

fn default() -> CodeOwners

Returns the “default value” for a type.

impl Eq for CodeOwners

impl PartialEq for CodeOwners

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodeOwners