SqlxWatcher

Struct SqlxWatcher 

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

A sqlx based Watcher for casbin policy changes.

The watcher is responsible for both notifying and listening to casbin policy changes. By default load_policy is called when any changes are received. The user can alter this behaviour via set_update_callback.

Since the Watcher trait doesn’t supply the payload to the callback, you can access that via the last_message field.

Example:

use casbin::Watcher;
use casbin_sqlx_watcher::SqlxWatcher;
use sqlx::PgPool;

#[tokio::main]
async fn main() {
   use std::sync::Arc;
   use casbin::{CoreApi, Enforcer};
   use tokio::sync::RwLock;
   let db = PgPool::connect(std::env::var("DATABASE_URL").unwrap_or_default().as_str()).await.unwrap();
   let mut watcher = SqlxWatcher::new(db.clone());
   let mut watcher_clone = watcher.clone();

   let policy = sqlx_adapter::SqlxAdapter::new_with_pool(db.clone()).await.unwrap();
   let model = casbin::DefaultModel::from_str(include_str!("./resources/rbac_model.conf")).await.unwrap();

   let enforcer = Arc::new(RwLock::new(Enforcer::new(model, policy).await.unwrap()));

   tokio::task::spawn(async move {
      if let Err(err) = watcher_clone.listen(enforcer).await {
         eprintln!("casbin watcher failed: {}", err);
     }
   });


   watcher.set_update_callback(Box::new(|| {
      println!("casbin policy changed");
   }));

   // This is not the recommended way to trigger changes, casbin will do that automatically.
   // But for illustration purposes, we can manually trigger a change.
   sqlx::query("NOTIFY casbin_policy_change").execute(&db).await.unwrap();

   tokio::time::sleep(tokio::time::Duration::from_secs(3)).await;
   // output: casbin policy changed
}

Implementations§

Source§

impl SqlxWatcher

Source

pub fn new(db: PgPool) -> Self

Source

pub fn set_channel(&mut self, channel: &str)

Set the channel to listen and notify on. By default, the value of DEFAULT_NOTIFY_CHANNEL is used, which is “casbin_policy_change”.

Source

pub fn channel(&self) -> String

Get the channel that is listened to and notified on.

Source

pub async fn listen(&mut self, enforcer: Arc<RwLock<Enforcer>>) -> Result<()>

The main listen loop

This listens to the postgres notification channel for casbin policy changes. It also listens for updates to the callback function.

Trait Implementations§

Source§

impl Clone for SqlxWatcher

Source§

fn clone(&self) -> SqlxWatcher

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 Watcher for SqlxWatcher

Source§

fn set_update_callback(&mut self, cb: Box<dyn FnMut() + Send + Sync>)

Source§

fn update(&mut self, d: EventData)

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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,