Struct Policy 

pub struct Policy {
    pub level: Access,
    pub org_class: Option<String>,
}

An access level, optionally narrowed to organisations of one class.

The grammar is any Access spelling followed by @org_class=<name>:

update = "role:admin"                  # admins of the active organisation
update = "role:admin@org_class=school" # …but only where it is a school
list   = "member@org_class=staff"      # any member of a staff organisation

An unqualified policy applies in every organisation, which is what every policy written before classes existed means — so adding classes to an app changes nothing until a policy asks for one.

The class is a filter on the organisation, never a widening: it is checked in addition to the level, so role:admin@org_class=school is strictly fewer people than role:admin.

Fields

level: Access

Who may act.

org_class: Option<String>

The org_class the organisation must carry, if the policy names one.

Implementations

impl Policy

pub fn parse(s: &str) -> Policy

Parse "<level>" or "<level>@org_class=<name>".

An empty or malformed class ("role:admin@org_class=") makes the whole policy private: the same direction a typo in a level takes, because a qualifier nobody can satisfy must not silently become one everybody can.

pub fn as_string(&self) -> String

The canonical string form, round-tripping Policy::parse.

pub fn matches_org_class(&self, class: Option<&str>) -> bool

Whether an organisation carrying class satisfies this policy’s class qualifier. An unqualified policy is satisfied by every organisation, including one with no class at all.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Eq for Policy

impl From<Access> for Policy

fn from(level: Access) -> Policy

Converts to this type from the input type.

impl PartialEq for Policy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Policy