Enum Permission 

#[repr(u8)]
pub enum Permission {
    Pull,
    Triage,
    Push,
    Maintain,
    Admin,
    Custom(RoleName),
}

A repository permission GitHub can grant.

The five built-in names are plain strings. A custom repository role is the object {"custom":"<role name>"}.

Variants

Pull

Read and clone.

Triage

Read, plus manage issues and pull requests.

Push

Read and write.

Maintain

Write, plus manage the repository without sensitive actions.

Admin

Full access.

Custom(RoleName)

A custom repository role of the organization.

Implementations

impl Permission

pub fn from_role_name(raw: &str) -> Option<Self>

Read the role name GitHub reports for a grant.

GitHub spells the built-in roles read and write in some responses. Any other name is a custom role.

pub fn observe(role: &str, flagged: Option<Self>) -> Observed<Self>

Combine the role name and the highest set permission flag of a grant.

A role name that is not a built-in role is a custom role. Otherwise the flag wins, and the role name is the fallback.

pub fn as_str(&self) -> &str

The name GitHub takes in a permission field.

pub const fn invitation_name(&self) -> Option<&'static str>

The name an invitation update takes, which has no custom roles.

pub const fn custom(&self) -> Option<&RoleName>

The custom role name, when this permission is a custom role.

Trait Implementations

impl Clone for Permission

fn clone(&self) -> Permission

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Permission

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

Formats the value using the given formatter.

impl Display for Permission

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

Formats the value using the given formatter.

impl Eq for Permission

impl<'ʄ> Facet<'ʄ> for Permission

const SHAPE: &'static Shape

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

impl FromStr for Permission

type Err = PermissionError

The associated error which can be returned from parsing.

fn from_str(raw: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Permission

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Permission

impl TryFrom<&Permission> for Value

type Error = PermissionError

The type returned in the event of a conversion error.

fn try_from(value: &Permission) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Permission

type Error = PermissionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.