Struct Permission 

#[non_exhaustive]
pub struct Permission {
    pub code: String,
    pub label: Text,
    pub group: Text,
    pub default_roles: Vec<String>,
    pub renamed_from: Vec<String>,
}

A permission an operator can be granted: a dotted code, a human label, and a group heading it sorts under in the role editor. The framework registers its own (see the built-in grants), and an application registers its permissions through router so they appear in the editor alongside.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: String

label: Text

The permission’s display label and group heading, localized at render.

group: Text

default_roles: Vec<String>

The built-in roles that hold this permission. Empty means ROLE_ADMIN alone.

renamed_from: Vec<String>

Codes this permission used to have. At boot every role and override still holding one is rewritten to the current code.

Implementations

impl Permission

pub fn new( code: impl Into<String>, label: impl Into<Text>, group: impl Into<Text>, ) -> Self

A permission an operator can be granted, held by ROLE_ADMIN until it names other roles with Permission::roles.

pub fn renamed_from<I, S>(self, codes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Codes this permission used to have.

A role or override still holding one is rewritten at the next boot, so a rename repairs what operators saved rather than leaving them granting a string nothing checks.

pub fn roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

The built-in roles that hold this permission by default. Naming ROLE_EDITOR alone keeps it out of ROLE_ADMIN.

Trait Implementations

impl Clone for Permission

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for Permission

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

where __S: Serializer,

Serialize this value into the given Serde serializer.