pub struct GroupManager { /* private fields */ }Available on crate feature
auth and non-WebAssembly only.Expand description
Group manager
Manages groups and their permissions.
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
// Create group
let group_data = CreateGroupData {
name: "Editors".to_string(),
description: Some("Content editors".to_string()),
};
let group = manager.create_group(group_data).await.unwrap();
assert_eq!(group.name, "Editors");
// Add permissions to group
manager.add_group_permission(&group.id.to_string(), "blog.add_article").await.unwrap();
manager.add_group_permission(&group.id.to_string(), "blog.change_article").await.unwrap();
// Add user to group
manager.add_user_to_group("alice", &group.id.to_string()).await.unwrap();
// Check user permissions
let perms = manager.get_user_permissions("alice").await.unwrap();
assert!(perms.contains(&"blog.add_article".to_string()));
}Implementations§
Source§impl GroupManager
impl GroupManager
Sourcepub fn new() -> GroupManager
pub fn new() -> GroupManager
Create a new group manager
§Examples
use reinhardt_auth::group_management::GroupManager;
let manager = GroupManager::new();Sourcepub async fn create_group(
&mut self,
data: CreateGroupData,
) -> Result<Group, GroupManagementError>
pub async fn create_group( &mut self, data: CreateGroupData, ) -> Result<Group, GroupManagementError>
Create a new group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Moderators".to_string(),
description: Some("Content moderators".to_string()),
};
let group = manager.create_group(group_data).await.unwrap();
assert_eq!(group.name, "Moderators");
}Sourcepub async fn get_group(
&self,
group_id: &str,
) -> Result<Group, GroupManagementError>
pub async fn get_group( &self, group_id: &str, ) -> Result<Group, GroupManagementError>
Get group by ID
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Viewers".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
let retrieved = manager.get_group(&group.id.to_string()).await.unwrap();
assert_eq!(retrieved.name, "Viewers");
}Sourcepub async fn get_group_by_name(
&self,
name: &str,
) -> Result<Group, GroupManagementError>
pub async fn get_group_by_name( &self, name: &str, ) -> Result<Group, GroupManagementError>
Get group by name
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Contributors".to_string(),
description: None,
};
manager.create_group(group_data).await.unwrap();
let retrieved = manager.get_group_by_name("Contributors").await.unwrap();
assert_eq!(retrieved.name, "Contributors");
}Sourcepub async fn delete_group(
&mut self,
group_id: &str,
) -> Result<(), GroupManagementError>
pub async fn delete_group( &mut self, group_id: &str, ) -> Result<(), GroupManagementError>
Delete group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "TempGroup".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.delete_group(&group.id.to_string()).await.unwrap();
assert!(manager.get_group(&group.id.to_string()).await.is_err());
}Sourcepub async fn add_group_permission(
&mut self,
group_id: &str,
permission: &str,
) -> Result<(), GroupManagementError>
pub async fn add_group_permission( &mut self, group_id: &str, permission: &str, ) -> Result<(), GroupManagementError>
Add permission to group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Writers".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_group_permission(&group.id.to_string(), "blog.add_article").await.unwrap();
let perms = manager.get_group_permissions(&group.id.to_string()).await.unwrap();
assert!(perms.contains(&"blog.add_article".to_string()));
}Sourcepub async fn remove_group_permission(
&mut self,
group_id: &str,
permission: &str,
) -> Result<(), GroupManagementError>
pub async fn remove_group_permission( &mut self, group_id: &str, permission: &str, ) -> Result<(), GroupManagementError>
Remove permission from group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Reviewers".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_group_permission(&group.id.to_string(), "blog.view_article").await.unwrap();
manager.remove_group_permission(&group.id.to_string(), "blog.view_article").await.unwrap();
let perms = manager.get_group_permissions(&group.id.to_string()).await.unwrap();
assert!(!perms.contains(&"blog.view_article".to_string()));
}Sourcepub async fn get_group_permissions(
&self,
group_id: &str,
) -> Result<Vec<String>, GroupManagementError>
pub async fn get_group_permissions( &self, group_id: &str, ) -> Result<Vec<String>, GroupManagementError>
Get group permissions
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Publishers".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_group_permission(&group.id.to_string(), "blog.add_article").await.unwrap();
manager.add_group_permission(&group.id.to_string(), "blog.publish_article").await.unwrap();
let perms = manager.get_group_permissions(&group.id.to_string()).await.unwrap();
assert_eq!(perms.len(), 2);
}Sourcepub async fn add_user_to_group(
&mut self,
username: &str,
group_id: &str,
) -> Result<(), GroupManagementError>
pub async fn add_user_to_group( &mut self, username: &str, group_id: &str, ) -> Result<(), GroupManagementError>
Add user to group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Members".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_user_to_group("alice", &group.id.to_string()).await.unwrap();
let groups = manager.get_user_groups("alice").await.unwrap();
assert_eq!(groups.len(), 1);
}Sourcepub async fn remove_user_from_group(
&mut self,
username: &str,
group_id: &str,
) -> Result<(), GroupManagementError>
pub async fn remove_user_from_group( &mut self, username: &str, group_id: &str, ) -> Result<(), GroupManagementError>
Remove user from group
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Staff".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_user_to_group("bob", &group.id.to_string()).await.unwrap();
manager.remove_user_from_group("bob", &group.id.to_string()).await.unwrap();
let groups = manager.get_user_groups("bob").await.unwrap();
assert_eq!(groups.len(), 0);
}Sourcepub async fn get_user_groups(
&self,
username: &str,
) -> Result<Vec<Group>, GroupManagementError>
pub async fn get_user_groups( &self, username: &str, ) -> Result<Vec<Group>, GroupManagementError>
Get user groups
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data1 = CreateGroupData {
name: "Team1".to_string(),
description: None,
};
let group_data2 = CreateGroupData {
name: "Team2".to_string(),
description: None,
};
let group1 = manager.create_group(group_data1).await.unwrap();
let group2 = manager.create_group(group_data2).await.unwrap();
manager.add_user_to_group("charlie", &group1.id.to_string()).await.unwrap();
manager.add_user_to_group("charlie", &group2.id.to_string()).await.unwrap();
let groups = manager.get_user_groups("charlie").await.unwrap();
assert_eq!(groups.len(), 2);
}Sourcepub async fn get_user_permissions(
&self,
username: &str,
) -> Result<Vec<String>, GroupManagementError>
pub async fn get_user_permissions( &self, username: &str, ) -> Result<Vec<String>, GroupManagementError>
Get user permissions from all groups
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data = CreateGroupData {
name: "Developers".to_string(),
description: None,
};
let group = manager.create_group(group_data).await.unwrap();
manager.add_group_permission(&group.id.to_string(), "code.commit").await.unwrap();
manager.add_group_permission(&group.id.to_string(), "code.review").await.unwrap();
manager.add_user_to_group("diana", &group.id.to_string()).await.unwrap();
let perms = manager.get_user_permissions("diana").await.unwrap();
assert!(perms.contains(&"code.commit".to_string()));
assert!(perms.contains(&"code.review".to_string()));
}Sourcepub async fn list_groups(&self) -> Vec<Group>
pub async fn list_groups(&self) -> Vec<Group>
List all groups
§Examples
use reinhardt_auth::group_management::{GroupManager, CreateGroupData};
#[tokio::main]
async fn main() {
let mut manager = GroupManager::new();
let group_data1 = CreateGroupData {
name: "Group1".to_string(),
description: None,
};
let group_data2 = CreateGroupData {
name: "Group2".to_string(),
description: None,
};
manager.create_group(group_data1).await.unwrap();
manager.create_group(group_data2).await.unwrap();
let groups = manager.list_groups().await;
assert_eq!(groups.len(), 2);
}Sourcepub fn get_permissions_for_groups_sync(
&self,
group_names: &[String],
) -> HashSet<String>
pub fn get_permissions_for_groups_sync( &self, group_names: &[String], ) -> HashSet<String>
Synchronously resolve permissions for the given group names.
Uses try_read() for non-blocking access to internal state.
Returns an empty set if the lock is held by a writer.
This method is designed for use in synchronous contexts such as
PermissionsMixin::get_group_permissions().
Trait Implementations§
Source§impl Debug for GroupManager
impl Debug for GroupManager
Source§impl Default for GroupManager
impl Default for GroupManager
Source§fn default() -> GroupManager
fn default() -> GroupManager
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for GroupManager
impl !RefUnwindSafe for GroupManager
impl Send for GroupManager
impl Sync for GroupManager
impl Unpin for GroupManager
impl UnsafeUnpin for GroupManager
impl !UnwindSafe for GroupManager
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
Creates a shared type from an unshared type.
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().Source§impl<E> ServerFnErrorAssertions<E> for Ewhere
E: Debug,
impl<E> ServerFnErrorAssertions<E> for Ewhere
E: Debug,
Source§fn should_contain_message(&self, expected: &str)where
E: Display,
fn should_contain_message(&self, expected: &str)where
E: Display,
Assert that the error message contains the specified text.
Source§fn should_have_message(&self, expected: &str)where
E: Display,
fn should_have_message(&self, expected: &str)where
E: Display,
Assert that the error message matches exactly.
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.