Skip to main content

Engine

Struct Engine 

Source
pub struct Engine { /* private fields */ }
Expand description

Decision engine. Immutable and shareable between threads once built.

Implementations§

Source§

impl Engine

Source

pub fn builder(catalog: impl Into<Arc<Catalog>>) -> EngineBuilder

Source

pub fn catalog(&self) -> &Catalog

Source

pub fn roles(&self) -> &RoleGraph

Source

pub fn check(&self, ctx: &Context<'_>, request: &Request<'_>) -> bool

Source

pub fn decide(&self, ctx: &Context<'_>, request: &Request<'_>) -> Decision

Source

pub fn decide_without_overrides( &self, ctx: &Context<'_>, request: &Request<'_>, ) -> Decision

Decision by the grants only, without overrides. Used by overrides that depend on a permission.

Source

pub fn explain(&self, ctx: &Context<'_>, request: &Request<'_>) -> Explanation

The same decision as Engine::decide, with the trace of each override and of each grant delivered by the source. More expensive: it evaluates the condition tree and clones the grants.

Source

pub fn validate_grant(&self, grant: &Grant) -> Result<(), GrantError>

Checks a grant against the catalog and the engine configuration before writing it.

Source

pub fn capabilities( &self, ctx: &Context<'_>, subject: &Subject, scope: &Resource, ) -> CapabilitySet

Preloads, in one trip to the source, the grants that may hold for subject within scope. The result is itself a GrantSource for repeated decisions (a WebSocket connection, a page with many buttons) and serializes for the frontend.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Engine

§

impl !UnwindSafe for Engine

§

impl Forget for Engine

§

impl Freeze for Engine

§

impl Move for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl UnsafeUnpin for Engine

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.