casbin/
core_api.rs

1use crate::{
2    enforcer::EnforceContext, model::OperatorFunction, Adapter, Effector,
3    EnforceArgs, Event, EventEmitter, Filter, Model, Result, RoleManager,
4    TryIntoAdapter, TryIntoModel,
5};
6
7#[cfg(feature = "watcher")]
8use crate::Watcher;
9
10#[cfg(feature = "logging")]
11use crate::Logger;
12
13#[cfg(feature = "incremental")]
14use crate::emitter::EventData;
15
16use async_trait::async_trait;
17use parking_lot::RwLock;
18
19use std::sync::Arc;
20
21#[async_trait]
22pub trait CoreApi: Send + Sync {
23    async fn new_raw<M: TryIntoModel, A: TryIntoAdapter>(
24        m: M,
25        a: A,
26    ) -> Result<Self>
27    where
28        Self: Sized;
29    async fn new<M: TryIntoModel, A: TryIntoAdapter>(
30        m: M,
31        a: A,
32    ) -> Result<Self>
33    where
34        Self: Sized;
35    fn add_function(&mut self, fname: &str, f: OperatorFunction);
36    fn get_model(&self) -> &dyn Model;
37    fn get_mut_model(&mut self) -> &mut dyn Model;
38    fn get_adapter(&self) -> &dyn Adapter;
39    fn get_mut_adapter(&mut self) -> &mut dyn Adapter;
40    #[cfg(feature = "watcher")]
41    fn set_watcher(&mut self, w: Box<dyn Watcher>);
42    #[cfg(feature = "watcher")]
43    fn get_watcher(&self) -> Option<&dyn Watcher>;
44    #[cfg(feature = "watcher")]
45    fn get_mut_watcher(&mut self) -> Option<&mut dyn Watcher>;
46    fn get_role_manager(&self) -> Arc<RwLock<dyn RoleManager>>;
47    fn set_role_manager(
48        &mut self,
49        rm: Arc<RwLock<dyn RoleManager>>,
50    ) -> Result<()>;
51    #[cfg(feature = "logging")]
52    fn get_logger(&self) -> &dyn Logger;
53    #[cfg(feature = "logging")]
54    fn set_logger(&mut self, logger: Box<dyn Logger>);
55    async fn set_model<M: TryIntoModel>(&mut self, m: M) -> Result<()>
56    where
57        Self: Sized;
58    async fn set_adapter<A: TryIntoAdapter>(&mut self, a: A) -> Result<()>
59    where
60        Self: Sized;
61    fn set_effector(&mut self, e: Box<dyn Effector>);
62    fn enforce<ARGS: EnforceArgs>(&self, rvals: ARGS) -> Result<bool>
63    where
64        Self: Sized;
65    fn enforce_with_context<ARGS: EnforceArgs>(
66        &self,
67        ctx: EnforceContext,
68        rvals: ARGS,
69    ) -> Result<bool>
70    where
71        Self: Sized;
72    fn enforce_mut<ARGS: EnforceArgs>(&mut self, rvals: ARGS) -> Result<bool>
73    where
74        Self: Sized;
75    #[cfg(feature = "explain")]
76    fn enforce_ex<ARGS: EnforceArgs>(
77        &self,
78        rvals: ARGS,
79    ) -> Result<(bool, Vec<Vec<String>>)>
80    where
81        Self: Sized;
82    fn build_role_links(&mut self) -> Result<()>;
83    #[cfg(feature = "incremental")]
84    fn build_incremental_role_links(&mut self, d: EventData) -> Result<()>;
85    async fn load_policy(&mut self) -> Result<()>;
86    async fn load_filtered_policy<'a>(&mut self, f: Filter<'a>) -> Result<()>;
87    fn is_filtered(&self) -> bool;
88    fn is_enabled(&self) -> bool;
89    async fn save_policy(&mut self) -> Result<()>;
90    async fn clear_policy(&mut self) -> Result<()>;
91    #[cfg(feature = "logging")]
92    fn enable_log(&mut self, enabled: bool);
93    fn enable_auto_save(&mut self, auto_save: bool);
94    fn enable_enforce(&mut self, enabled: bool);
95    fn enable_auto_build_role_links(&mut self, auto_build_role_links: bool);
96    #[cfg(feature = "watcher")]
97    fn enable_auto_notify_watcher(&mut self, auto_notify_watcher: bool);
98    fn has_auto_save_enabled(&self) -> bool;
99    #[cfg(feature = "watcher")]
100    fn has_auto_notify_watcher_enabled(&self) -> bool;
101    fn has_auto_build_role_links_enabled(&self) -> bool;
102}
103
104pub trait IEnforcer: CoreApi + EventEmitter<Event> {}
105
106impl<T> IEnforcer for T where T: CoreApi + EventEmitter<Event> {}
casbin/core_api.rs

casbin/
core_api.rs
