Struct Protection 

pub struct Protection {

    pub trunk_ruleset: Option<String>,
    pub safety_ruleset: Option<String>,
    pub tag_ruleset: String,
    pub lines_ruleset: String,
    pub title_check: String,
    pub tag_pattern: String,
    pub bypass_actors: Vec<String>,
    pub allowed_merge_methods: Vec<String>,
    pub strict_required_status_checks: bool,
    pub owned_trunk_rules: Vec<String>,
    pub required_approving_review_count: i64,
    pub dismiss_stale_reviews_on_push: bool,
    pub require_code_owner_review: bool,
    pub require_last_push_approval: bool,
    pub github: Github,
    pub gitlab: Gitlab,
}

The protection table.

Fields

trunk_ruleset: Option<String>

N: trunk ruleset name. Absent derives <trunk>-protection, which is the name the setup script built before the key existed, so a target that states none keeps the ruleset it already has.

safety_ruleset: Option<String>

N: safety ruleset name. Absent derives <trunk>-safety. This is the ruleset that names no bypass actor, so the deletion and force-push protections hold against every actor including the one the trunk ruleset may excuse.

tag_ruleset: String

N: tag ruleset name.

lines_ruleset: String

N: release-line ruleset name.

title_check: String

N: title job context.

tag_pattern: String

F: invariant, covers every published version.

bypass_actors: Vec<String>

F: invariant, the actors git.integration names. It excuses the trunk ruleset alone; the safety ruleset names nobody.

allowed_merge_methods: Vec<String>

F: invariant, exactly squash.

strict_required_status_checks: bool

F: invariant, true.

owned_trunk_rules: Vec<String>

F: invariant, the rules git.integration names. A landing writes this key with the authority, and a target that narrowed or widened it keeps what it stated.

required_approving_review_count: i64

F: floor zero; higher is stricter.

dismiss_stale_reviews_on_push: bool

F: floor false; true is stricter.

require_code_owner_review: bool

F: floor false; true is stricter.

require_last_push_approval: bool

F: floor false; true is stricter.

github: Github

GitHub policy.

gitlab: Gitlab

GitLab policy.

Implementations

impl Protection

pub fn trunk_ruleset(&self, trunk: &str) -> String

The trunk ruleset’s name: the target’s own answer, or the name the setup script derived before the key existed.

pub fn safety_ruleset(&self, trunk: &str) -> String

The safety ruleset’s name: the target’s own answer, or the derived <trunk>-safety.

A separate ruleset because a bypass actor is recorded on a ruleset and never on a rule. The deletion and force-push rules therefore cannot sit beside a bypassed rule without inheriting its excuse.

Trait Implementations

impl Clone for Protection

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 Protection

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

Formats the value using the given formatter.

impl Default for Protection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Protection

where Protection: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Protection

impl PartialEq for Protection

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Protection

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 Protection