Struct Rules 

pub struct Rules {

    pub required_status_checks: Option<StatusChecksRule>,
    pub pull_request: Option<PullRequestRule>,
    pub required_signatures: bool,
    pub non_fast_forward: bool,
    pub deletion: bool,
    pub creation: bool,
    pub required_linear_history: bool,
    pub update: Option<UpdateRule>,
    pub required_deployments: Option<DeploymentsRule>,
    pub commit_message_pattern: Option<PatternRule>,
    pub commit_author_email_pattern: Option<PatternRule>,
    pub committer_email_pattern: Option<PatternRule>,
    pub branch_name_pattern: Option<PatternRule>,
    pub tag_name_pattern: Option<PatternRule>,
    pub workflows: Option<WorkflowsRule>,
    pub code_scanning: Option<CodeScanningRule>,
    pub merge_queue: Option<MergeQueueRule>,
}

The rules of a ruleset. A false switch and a null rule are absent.

Fields

required_status_checks: Option<StatusChecksRule>

Require status checks to pass.

pull_request: Option<PullRequestRule>

Require changes to arrive through a pull request.

required_signatures: bool

Require signed commits.

non_fast_forward: bool

Block force pushes.

deletion: bool

Block deleting matching refs.

creation: bool

Block creating matching refs.

required_linear_history: bool

Require a linear history.

update: Option<UpdateRule>

Restrict updating matching refs.

required_deployments: Option<DeploymentsRule>

Require successful deployments.

commit_message_pattern: Option<PatternRule>

Require commit messages to match a pattern.

commit_author_email_pattern: Option<PatternRule>

Require commit author emails to match a pattern.

committer_email_pattern: Option<PatternRule>

Require committer emails to match a pattern.

branch_name_pattern: Option<PatternRule>

Require branch names to match a pattern.

tag_name_pattern: Option<PatternRule>

Require tag names to match a pattern.

workflows: Option<WorkflowsRule>

Require workflows to pass.

code_scanning: Option<CodeScanningRule>

Require code scanning results.

merge_queue: Option<MergeQueueRule>

Require a merge queue.

Implementations

impl Rules

pub(crate) const fn none() -> Self

Rules with every switch off and every rule absent.

pub(crate) fn entries(&self) -> Vec<RuleRef<'_>>

The rules in the order they are written to GitHub.

pub(crate) fn absorb<D: RuleDecoder>( &mut self, kind: &str, decoder: &D, ) -> Result<bool, D::Error>

Read one rule of a live ruleset into the matching field.

Returns whether the rule type is one Rules can hold.

Errors

Returns the decoder’s error when the parameters do not decode.

pub(crate) fn compare(&self, live: Option<&Self>, diff: &mut FieldDiff)

Compare every rule with the live rules.

impl Rules

pub(super) fn normalize(&mut self)

Put every list in its comparison order and drop a dismissal restriction that is off and names no actors.

Trait Implementations

impl Clone for Rules

fn clone(&self) -> Rules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rules

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

Formats the value using the given formatter.

impl Eq for Rules

impl<'ʄ> Facet<'ʄ> for Rules

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for Rules

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Rules