Struct BranchProtection 

pub struct BranchProtection {
    pub required_status_checks: Option<RequiredStatusChecks>,
    pub enforce_admins: bool,
    pub required_pull_request_reviews: Option<PullRequestReviewEnforcement>,
    pub restrictions: Option<BranchRestrictions>,
    pub required_linear_history: bool,
    pub allow_force_pushes: bool,
    pub allow_deletions: bool,
    pub block_creations: bool,
    pub required_conversation_resolution: bool,
    pub lock_branch: bool,
    pub allow_fork_syncing: bool,
}

Branch protection rules that control how a branch can be modified

Fields

required_status_checks: Option<RequiredStatusChecks>

Status checks that must pass before merging

enforce_admins: bool

Whether to enforce all configured restrictions for administrators

required_pull_request_reviews: Option<PullRequestReviewEnforcement>

Pull request review requirements

restrictions: Option<BranchRestrictions>

Restrictions on who can push to the branch

required_linear_history: bool

Whether to require a linear commit history (no merge commits)

allow_force_pushes: bool

Whether to allow force pushes to the branch

allow_deletions: bool

Whether to allow branch deletions

block_creations: bool

Whether to block creation of matching branches

required_conversation_resolution: bool

Whether to require all conversations on code to be resolved before merging

lock_branch: bool

Whether to lock the branch, making it read-only

allow_fork_syncing: bool

Whether to allow users with push access to sync from upstream forks

Trait Implementations

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 Documented for BranchProtection

const DOCS: &'static str = "Branch protection rules that control how a branch can be modified"

The static doc comments on this type.

impl DocumentedFields for BranchProtection

const FIELD_NAMES: &'static [&'static str]

Field names, as accepted by Self::get_field_docs.

const FIELD_DOCS: &'static [&'static str]

The static doc comments on each field or variant of this type, indexed by field/variant order.

fn get_field_docs<T>(field_name: T) -> Result<&'static str, Error>

where T: AsRef<str>,

Get a field’s documentation using its name.

impl FieldTypes for BranchProtection

fn field_type<__Documented_T: AsRef<str>>( field_name: __Documented_T, ) -> Option<&'static str>

Get a field’s type using its name.

impl PartialEq for BranchProtection

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for BranchProtection