Struct bonsaidb_core::permissions::Permissions

pub struct Permissions { /* private fields */ }

A collection of allowed permissions. This is constructed from a Vec<Statement>. By default, no actions are allowed on any resources.

Implementations

impl Permissions

pub fn allow_all() -> Permissions

Returns a Permisions instance constructed with Statement::allow_all().

pub fn check<'a, R, P>( &self, resource_name: R, action: &P ) -> Result<(), PermissionDenied>where R: AsRef<[Identifier<'a>]>, P: Action,

Evaluate whether the action is allowed to be taken upon resource_name. Returns Ok if permission is allowed.

Errors

Returns PermissionDenied if permission is now allowed.

pub fn allowed_to<'a, R, P>(&self, resource_name: R, action: &P) -> boolwhere R: AsRef<[Identifier<'a>]>, P: Action,

Evaluate whether the action is allowed to be taken upon resource_name. Returns true if the action should be allowed. If no statements that match resource_name allow action, false will be returned.

pub fn get<'a, 's, R>( &'s self, resource_name: R, key: &str ) -> Option<&'s Configuration>where 'a: 's, R: AsRef<[Identifier<'a>]>,

Looks up a configured value for resource_name.

pub fn merged<'a>( permissions: impl IntoIterator<Item = &'a Permissions> ) -> Permissions

Returns a new instance that merges all allowed actions from permissions.

Trait Implementations

impl Clone for Permissions

fn clone(&self) -> Permissions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Permissions

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

Formats the value using the given formatter.

impl Default for Permissions

fn default() -> Permissions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Permissions

fn deserialize<__D>( __deserializer: __D ) -> Result<Permissions, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Statement> for Permissions

fn from(stmt: Statement) -> Permissions

Converts to this type from the input type.

impl From<Vec<Statement, Global>> for Permissions

fn from(statements: Vec<Statement, Global>) -> Permissions

Converts to this type from the input type.

impl Serialize for Permissions

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

Serialize this value into the given Serde serializer.