RestrictedConnection

Struct RestrictedConnection 

Source
pub struct RestrictedConnection { /* private fields */ }
Available on crate feature rbac only.
Expand description

Wrapper of DatabaseConnection that performs authorization on all executed queries for the current user. Note that raw SQL Statement is not allowed currently.

Implementationsยง

Sourceยง

impl RestrictedConnection

Source

pub fn user_id(&self) -> UserId

Get the [RbacUserId] bounded to this connection.

Source

pub fn user_can_run<S: StatementBuilder>(&self, stmt: &S) -> Result<(), DbErr>

Returns () if the current user can execute / query the given SQL statement. Returns DbErr::AccessDenied otherwise.

Source

pub fn user_can<P, R>(&self, permission: P, resource: R) -> Result<bool, DbErr>

Returns true if the current user can perform action on resource

Source

pub fn current_user_role_permissions( &self, ) -> Result<RbacUserRolePermissions, DbErr>

Get current userโ€™s role and associated permissions. This includes permissions โ€œinheritedโ€ from child roles.

Source

pub fn roles_and_ranks(&self) -> Result<RbacRolesAndRanks, DbErr>

Get a list of all roles and their ranks. Rank is defined as (1 + number of child roles).

Source

pub fn resources_and_permissions( &self, ) -> Result<RbacResourcesAndPermissions, DbErr>

Get two lists of all resources and permissions, excluding wildcards.

Source

pub fn role_hierarchy_edges( &self, role_id: RoleId, ) -> Result<RbacRoleHierarchyList, DbErr>

Get a list of edges walking the role hierarchy tree

Source

pub fn role_permissions_by_resources( &self, role_id: RoleId, ) -> Result<RbacPermissionsByResources, DbErr>

Get a list of permissions for the specific role, grouped by resources. This does not include permissions of child roles.

Trait Implementationsยง

Sourceยง

impl Clone for RestrictedConnection

Sourceยง

fn clone(&self) -> RestrictedConnection

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl ConnectionTrait for RestrictedConnection

Sourceยง

fn get_database_backend(&self) -> DbBackend

Get the database backend for the connection. This depends on feature flags enabled.
Sourceยง

fn execute_raw(&self, stmt: Statement) -> Result<ExecResult, DbErr>

Execute a Statement
Sourceยง

fn execute<S: StatementBuilder>(&self, stmt: &S) -> Result<ExecResult, DbErr>

Execute a [QueryStatement]
Sourceยง

fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr>

Execute a unprepared Statement
Sourceยง

fn query_one_raw(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr>

Execute a Statement and return a single row of QueryResult
Sourceยง

fn query_one<S: StatementBuilder>( &self, stmt: &S, ) -> Result<Option<QueryResult>, DbErr>

Execute a [QueryStatement] and return a single row of QueryResult
Sourceยง

fn query_all_raw(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr>

Execute a Statement and return a vector of QueryResult
Sourceยง

fn query_all<S: StatementBuilder>( &self, stmt: &S, ) -> Result<Vec<QueryResult>, DbErr>

Execute a [QueryStatement] and return a vector of QueryResult
Sourceยง

fn support_returning(&self) -> bool

Check if the connection supports RETURNING syntax on insert and update
Sourceยง

fn is_mock_connection(&self) -> bool

Check if the connection is a test connection for the Mock database
Sourceยง

impl Debug for RestrictedConnection

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl TransactionTrait for RestrictedConnection

Sourceยง

fn transaction<F, T, E>(&self, callback: F) -> Result<T, TransactionError<E>>
where F: for<'c> FnOnce(&'c RestrictedTransaction) -> Result<T, E>, E: Display + Debug,

Execute the function inside a transaction. If the function returns an error, the transaction will be rolled back. If it does not return an error, the transaction will be committed.

Sourceยง

fn transaction_with_config<F, T, E>( &self, callback: F, isolation_level: Option<IsolationLevel>, access_mode: Option<AccessMode>, ) -> Result<T, TransactionError<E>>
where F: for<'c> FnOnce(&'c RestrictedTransaction) -> Result<T, E>, E: Display + Debug,

Execute the function inside a transaction. If the function returns an error, the transaction will be rolled back. If it does not return an error, the transaction will be committed.

Sourceยง

type Transaction = RestrictedTransaction

The concrete type for the transaction
Sourceยง

fn begin(&self) -> Result<RestrictedTransaction, DbErr>

Execute SQL BEGIN transaction. Returns a Transaction that can be committed or rolled back
Sourceยง

fn begin_with_config( &self, isolation_level: Option<IsolationLevel>, access_mode: Option<AccessMode>, ) -> Result<RestrictedTransaction, DbErr>

Execute SQL BEGIN transaction with isolation level and/or access mode. Returns a Transaction that can be committed or rolled back

Auto Trait Implementationsยง

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> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

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

Sourceยง

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more