Struct BranchProtection 

pub struct BranchProtection {

    pub id: u64,
    pub repo_key: String,
    pub pattern: String,
    pub require_pr: bool,
    pub required_reviews: u32,
    pub required_status_checks: HashSet<String>,
    pub dismiss_stale_reviews: bool,
    pub require_code_owner_review: bool,
    pub restrict_pushes: bool,
    pub allow_force_push: bool,
    pub allow_deletion: bool,
    pub created_at: u64,
    pub updated_at: u64,
}

Branch protection rule for a repository.

Branch protection prevents direct pushes to important branches, requiring pull requests with reviews instead.

Fields

id: u64

Unique rule ID.

repo_key: String

Repository key (e.g., “owner/repo”).

pattern: String

Branch pattern (e.g., “main”, “release/*”).

require_pr: bool

Require changes via pull request.

required_reviews: u32

Minimum number of approving reviews required.

required_status_checks: HashSet<String>

Required status checks that must pass.

dismiss_stale_reviews: bool

Dismiss stale reviews when new commits are pushed.

require_code_owner_review: bool

Require review from code owners.

restrict_pushes: bool

Restrict who can push (only admins if true).

allow_force_push: bool

Allow force pushes.

allow_deletion: bool

Allow branch deletion.

created_at: u64

When the rule was created (Unix timestamp).

updated_at: u64

When the rule was last updated (Unix timestamp).

Implementations

impl BranchProtection

pub fn new(id: u64, repo_key: String, pattern: String) -> Self

Create a new branch protection rule with defaults.

pub fn matches(&self, branch: &str) -> bool

Check if this rule matches a branch name.

pub fn allows_direct_push(&self, is_admin: bool) -> bool

Check if a direct push is allowed (without PR).

pub fn allows_force_push(&self) -> bool

Check if a force push is allowed.

pub fn allows_deletion(&self) -> bool

Check if branch deletion is allowed.

pub fn check_reviews( &self, approving_reviews: u32, has_code_owner_review: bool, ) -> bool

Check if a PR meets the review requirements.

pub fn check_status(&self, passed_checks: &HashSet<String>) -> bool

Check if all required status checks have passed.

pub fn add_required_check(&mut self, check: String)

Add a required status check.

pub fn remove_required_check(&mut self, check: &str) -> bool

Remove a required status check.

Trait Implementations

impl Clone for BranchProtection

fn clone(&self) -> BranchProtection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchProtection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchProtection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BranchProtection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.