Struct CreateBranchProtectionOption 

pub struct CreateBranchProtectionOption {

    pub rule_name: String,
    pub apply_to_admins: bool,
    pub approvals_whitelist_teams: Vec<String>,
    pub approvals_whitelist_username: Vec<String>,
    pub block_on_official_review_requests: bool,
    pub block_on_outdated_branch: bool,
    pub block_on_rejected_reviews: bool,
    pub dismiss_stale_approvals: bool,
    pub enable_approvals_whitelist: bool,
    pub enable_merge_whitelist: bool,
    pub enable_push: bool,
    pub enable_push_whitelist: bool,
    pub enable_status_check: bool,
    pub ignore_stale_approvals: bool,
    pub merge_whitelist_teams: Vec<String>,
    pub merge_whitelist_usernames: Vec<String>,
    pub protected_file_patterns: String,
    pub push_whitelist_deploy_keys: bool,
    pub push_whitelist_teams: Vec<String>,
    pub push_whitelist_usernames: Vec<String>,
    pub require_signed_commits: bool,
    pub required_approvals: i64,
    pub status_check_contexts: Vec<String>,
    pub unprotected_file_patterns: String,
}

The managed subset of CreateBranchProtectionOption.

Every property is plain bool, int64 or []string with no omitempty, so Forgejo stores an omitted property as false, 0 or empty and still reports success. A differential POST would therefore create a rule with protection switched off. Every managed property is sent on every create.

The deprecated branch_name is never sent: rule_name supersedes it, and sending both lets the forge pick.

Fields

rule_name: String

The rule’s name.

apply_to_admins: bool

Whether the protection also applies to repository administrators.

approvals_whitelist_teams: Vec<String>

The teams whose approvals count, when the approvals whitelist is on.

approvals_whitelist_username: Vec<String>

The users whose approvals count, when the approvals whitelist is on.

block_on_official_review_requests: bool

Whether an official code owner review request blocks merging until resolved.

block_on_outdated_branch: bool

Whether merging is blocked while the branch is behind its base.

block_on_rejected_reviews: bool

Whether a requested change blocks merging until it is resolved.

dismiss_stale_approvals: bool

Whether a new commit dismisses existing approvals.

enable_approvals_whitelist: bool

Whether only the approvals whitelist counts toward the required approvals.

enable_merge_whitelist: bool

Whether only the merge whitelist may merge.

enable_push: bool

Whether direct pushes to the branch are allowed at all.

enable_push_whitelist: bool

Whether only the push whitelist may push.

enable_status_check: bool

Whether status checks must pass before merging.

ignore_stale_approvals: bool

Whether approvals on an outdated commit stop counting.

merge_whitelist_teams: Vec<String>

The teams that may merge, when the merge whitelist is on.

merge_whitelist_usernames: Vec<String>

The users that may merge, when the merge whitelist is on.

protected_file_patterns: String

Semicolon separated glob patterns for files that only whitelisted pushers may change.

push_whitelist_deploy_keys: bool

Whether deploy keys may push, when the push whitelist is on.

push_whitelist_teams: Vec<String>

The teams that may push, when the push whitelist is on.

push_whitelist_usernames: Vec<String>

The users that may push, when the push whitelist is on.

require_signed_commits: bool

Whether every commit on the branch must be signed.

required_approvals: i64

The number of approving reviews required before merging.

status_check_contexts: Vec<String>

The status check contexts that must report success.

unprotected_file_patterns: String

Semicolon separated glob patterns for files that any pusher may change despite the protected patterns.

Implementations

impl CreateBranchProtectionOption

pub fn new(rule_name: &str, desired: &BranchRule) -> Self

Build a complete create body from the desired state.

Trait Implementations

impl Clone for CreateBranchProtectionOption

fn clone(&self) -> CreateBranchProtectionOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBranchProtectionOption

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

Formats the value using the given formatter.

impl Eq for CreateBranchProtectionOption

impl<'ʄ> Facet<'ʄ> for CreateBranchProtectionOption

const SHAPE: &'static Shape

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

impl PartialEq for CreateBranchProtectionOption

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CreateBranchProtectionOption