Struct Rule 

pub struct Rule {
    pub pattern: String,
    pub owners: Vec<String>,
    pub description: Option<String>,
    pub section: Option<String>,
}

A single code ownership rule.

Each rule maps a file pattern to one or more owners.

Example

use cuenv_codeowners::Rule;

let rule = Rule::new("*.rs", ["@rust-team", "@backend"])
    .description("Rust source files")
    .section("Backend");

Fields

pattern: String

File pattern (glob syntax) matching files this rule applies to.

owners: Vec<String>

List of owners for files matching this pattern.

description: Option<String>

Optional description added as a comment above the rule.

section: Option<String>

Optional section name for grouping rules in the output.

Implementations

impl Rule

pub fn new( pattern: impl Into<String>, owners: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Create a new rule with a pattern and owners.

Example

use cuenv_codeowners::Rule;

let rule = Rule::new("*.rs", ["@rust-team"]);
let rule = Rule::new("/docs/**", vec!["@docs-team", "@tech-writers"]);

pub fn description(self, description: impl Into<String>) -> Self

Add a description to this rule.

The description will be added as a comment above the rule in the output.

pub fn section(self, section: impl Into<String>) -> Self

Assign this rule to a section.

Rules with the same section will be grouped together in the output.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl PartialEq for Rule

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Rule

impl StructuralPartialEq for Rule