Struct ProtectionState 

#[non_exhaustive]
pub struct ProtectionState {

    pub present: bool,
    pub enforced: bool,
    pub covers_default_branch: bool,
    pub requires_pull_request: bool,
    pub required_checks: Vec<String>,
    pub blocks_force_push: bool,
    pub blocks_deletion: bool,
    pub bypass_actors: Vec<String>,
    pub other_gaps: Vec<ProtectionGap>,
    pub check_source_guard: CheckSourceGuard,
    pub protected_paths: Vec<String>,
    pub merge_methods: Option<Vec<MergeMethod>>,
    pub ci_enabled: Option<bool>,
}

The default-branch protection that makes the check mean something, as observed. Each flag is the protective state, so Default is “nothing protected”.

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.

present: bool

The managed rule (ruleset, branch protection) exists.

enforced: bool

It is enforced, not disabled or in evaluate-only mode.

covers_default_branch: bool

It covers the default branch.

requires_pull_request: bool

Changes must come through a pull request.

required_checks: Vec<String>

Status checks the rule requires (by context name).

blocks_force_push: bool

Force-pushes are blocked.

blocks_deletion: bool

Branch deletion is blocked.

bypass_actors: Vec<String>

Actors allowed to bypass it. Must be empty (§5.3).

other_gaps: Vec<ProtectionGap>

Shortfalls in what keeps the check’s own workflow out of the change under test’s reach (a namespace required workflow, owner review), which the fields above cannot express. The adapter fills this in.

check_source_guard: CheckSourceGuard

Which guard keeps the check out of the pull request’s reach.

protected_paths: Vec<String>

Paths a pull request may not change (forge glob syntax), for a forge that protects the workflow this way. Empty when not read.

merge_methods: Option<Vec<MergeMethod>>

The merge methods the repository allows, for an adapter that reads them. None: not observed.

ci_enabled: Option<bool>

Whether the forge’s CI is enabled on the repository, for an adapter that reads it. None: not observed.

Trait Implementations

impl Clone for ProtectionState

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 ProtectionState

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

Formats the value using the given formatter.

impl Default for ProtectionState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtectionState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProtectionState

impl PartialEq for ProtectionState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProtectionState

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 ProtectionState