Struct biscuit_auth::builder::Rule

pub struct Rule {
    pub head: Predicate,
    pub body: Vec<Predicate>,
    pub expressions: Vec<Expression>,
    pub parameters: Option<HashMap<String, Option<Term>>>,
    pub scopes: Vec<Scope>,
    pub scope_parameters: Option<HashMap<String, Option<PublicKey>>>,
}

Builder for a Datalog rule

Fields

head: Predicate

body: Vec<Predicate>

expressions: Vec<Expression>

parameters: Option<HashMap<String, Option<Term>>>

scopes: Vec<Scope>

scope_parameters: Option<HashMap<String, Option<PublicKey>>>

Implementations

impl Rule

pub fn new(
    head: Predicate,
    body: Vec<Predicate>,
    expressions: Vec<Expression>,
    scopes: Vec<Scope>
) -> Rule

pub fn validate_parameters(&self) -> Result<(), Token>

pub fn validate_variables(&self) -> Result<(), String>

pub fn set<T: Into<Term>>(&mut self, name: &str, term: T) -> Result<(), Token>

replace a parameter with the term argument

pub fn set_lenient<T: Into<Term>>(
    &mut self,
    name: &str,
    term: T
) -> Result<(), Token>

replace a parameter with the term argument, without raising an error if the parameter is not present in the rule

pub fn set_scope(&mut self, name: &str, pubkey: PublicKey) -> Result<(), Token>

replace a scope parameter with the pubkey argument

pub fn set_scope_lenient(
    &mut self,
    name: &str,
    pubkey: PublicKey
) -> Result<(), Token>

replace a scope parameter with the public key argument, without raising an error if the parameter is not present in the rule scope

pub fn set_macro_param<T: ToAnyParam>(
    &mut self,
    name: &str,
    param: T
) -> Result<(), Token>

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Convert<Rule> for Rule

fn convert(&self, symbols: &mut SymbolTable) -> Rule

fn convert_from(r: &Rule, symbols: &SymbolTable) -> Result<Self, Format>

impl Debug for Rule

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

Formats the value using the given formatter.

impl Display for Rule

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

Formats the value using the given formatter.

impl From<Rule> for Rule

fn from(r: Rule) -> Self

Converts to this type from the input type.

impl FromStr for Rule

type Err = Token

The associated error which can be returned from parsing.

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

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

impl PartialEq<Rule> for Rule

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Rule

type Error = Token

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Rule> for Check

type Error = Token

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Rule

impl StructuralEq for Rule

impl StructuralPartialEq for Rule