Struct ProtectionSpec 

#[non_exhaustive]
pub struct ProtectionSpec {
    pub required_check: String,
    pub require_pull_request: bool,
    pub block_force_push: bool,
    pub block_deletion: bool,
    pub require_status_check: bool,
    pub require_code_owner_review: bool,
    pub protected_paths: Vec<String>,
}

Branch protection to enforce on the default branch.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

required_check: String

The status check that must pass.

require_pull_request: bool

Changes must come through a pull request.

block_force_push: bool

Block force-pushes.

block_deletion: bool

Block deletion.

require_status_check: bool

Require ProtectionSpec::required_check in this rule. false when the check is enforced at the namespace level instead (a required workflow, StepAction::RequireNamespaceWorkflow), so this rule carries only the PR, force-push and deletion parts.

require_code_owner_review: bool

Pull requests need an approving review, including a code owner’s for files that have one (StepAction::RequireOwnerReview).

protected_paths: Vec<String>

Paths (forge glob syntax) a pull request may not change and still merge: the workflows and the exempt keyring. Without this a PR could rewrite the check it is judged by — CI runs the PR’s own copy of the workflow — and pass itself. Empty where the forge enforces this some other way or not at all.

Implementations

impl ProtectionSpec

pub fn standard(check: impl Into<String>) -> Self

The §5.3 protection: PR required, check required, no force-push, no deletion. There is deliberately no bypass field — the design allows no bypass actors, so there is nothing to configure.

pub fn with_protected_paths<I, S>(self, paths: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Also forbid pull requests that change paths.

pub fn with_check_enforced_by_namespace(self) -> Self

Leave the check out of this rule: a namespace-level required workflow enforces it.

pub fn with_code_owner_review(self) -> Self

Require an approving review, and a code owner’s where one is named.

Trait Implementations

impl Clone for ProtectionSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtectionSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtectionSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProtectionSpec

impl PartialEq for ProtectionSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProtectionSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProtectionSpec