CodeownersBuilder

Struct CodeownersBuilder 

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

Builder for Codeowners.

§Example

use cuenv_codeowners::{Codeowners, Platform, Rule};

let codeowners = Codeowners::builder()
    .platform(Platform::Github)
    .header("Code ownership rules")
    .default_owners(["@org/maintainers"])
    .rule(Rule::new("*.rs", ["@rust-team"]))
    .rules([
        Rule::new("/docs/**", ["@docs-team"]),
        Rule::new("/ci/**", ["@devops"]),
    ])
    .build();

Implementations§

Source§

impl CodeownersBuilder

Source

pub fn platform(self, platform: Platform) -> Self

Set the target platform.

Source

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

Set a custom output path.

Overrides the platform’s default path.

Source

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

Set a custom header comment.

The header will be added at the top of the file with # prefixes.

Source

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

Set default owners for all files.

This creates a * @owner1 @owner2 rule at the top of the file.

Source

pub fn rule(self, rule: Rule) -> Self

Add a single rule.

Source

pub fn rules(self, rules: impl IntoIterator<Item = Rule>) -> Self

Add multiple rules.

Source

pub fn build(self) -> Codeowners

Build the Codeowners configuration.

Trait Implementations§

Source§

impl Clone for CodeownersBuilder

Source§

fn clone(&self) -> CodeownersBuilder

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodeownersBuilder

Source§

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

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

impl Default for CodeownersBuilder

Source§

fn default() -> CodeownersBuilder

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

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.