Enum toql_core::role_expr::RoleExpr

pub enum RoleExpr {
    And(Box<RoleExpr>, Box<RoleExpr>),
    Or(Box<RoleExpr>, Box<RoleExpr>),
    Not(Box<RoleExpr>),
    Role(String),
    Invalid,
}

A RoleExpr is a boolean expression tree.

It is typically parsed by the RoleExprParser. However it can also be build programmatically.

Here an example for the expression admin or power_user:

use toql_core::role_expr::RoleExpr;

let e = RoleExpr::Role("admin".to_string())
               .or(RoleExpr::Role("power_user".to_string()));
assert_eq!("(`admin`); (`power_user`)", e.to_string());

Notice that the string representation of OR always comes with parenthesis to express logical priority. To validate a role expression use the RoleValidator.

RoleExpr are used by Toql derive generated code.

End users should restrict actions with role expressions through the Toql derive.

Example

Restricting the field’s selection to the roles ‘admin’ or ‘power_user’

use toql_derive::Toql;

#[derive(Toql)]
struct FooBar {
  #[toql(key)]
  id: u64,

  #[toql(roles(load="admin;power_user"))]
  name: Option<String>
}

Variants

And(Box<RoleExpr>, Box<RoleExpr>)

Concatenate both nodes with AND

Or(Box<RoleExpr>, Box<RoleExpr>)

Concatenate both nodes with OR

Not(Box<RoleExpr>)

Negate node

Role(String)

This node is a role name

Invalid

This node is always invalid

Implementations

impl RoleExpr

pub fn invalid() -> Self

pub fn role(role: String) -> Self

pub fn and(self, role_expr: RoleExpr) -> Self

pub fn or(self, role_expr: RoleExpr) -> Self

pub fn not(self) -> Self

Trait Implementations

impl Clone for RoleExpr

fn clone(&self) -> RoleExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoleExpr

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

Formats the value using the given formatter.

impl ToString for RoleExpr

fn to_string(&self) -> String

Converts the given value to a String.