Struct typedb_driver::UserManager

pub struct UserManager { /* private fields */ }

Provides access to all user management methods.

Implementations

impl UserManager

pub fn new(connection: Connection) -> Self

pub async fn current_user(&self) -> Result<Option<User>>

Returns the logged-in user for the connection.

Examples

driver.users.current_user().await;

pub async fn all(&self) -> Result<Vec<User>>

Retrieves all users which exist on the TypeDB server.

Examples

driver.users.all().await;

pub async fn contains(&self, username: impl Into<String>) -> Result<bool>

Checks if a user with the given name exists.

Arguments

• username – The user name to be checked

Examples

driver.users.contains(username).await;

pub async fn create( &self, username: impl Into<String>, password: impl Into<String> ) -> Result

Create a user with the given name & password.

Arguments

• username – The name of the user to be created
• password – The password of the user to be created

Examples

driver.users.create(username, password).await;

pub async fn delete(&self, username: impl Into<String>) -> Result

Deletes a user with the given name.

Arguments

• username – The name of the user to be deleted

Examples

driver.users.delete(username).await;

pub async fn get(&self, username: impl Into<String>) -> Result<Option<User>>

Retrieve a user with the given name.

Arguments

• username – The name of the user to retrieve

Examples

driver.users.get(username).await;

pub async fn set_password( &self, username: impl Into<String>, password: impl Into<String> ) -> Result

Sets a new password for a user. This operation can only be performed by administrators.

Arguments

• username – The name of the user to set the password of
• password – The new password

Examples

driver.users.password_set(username, password).await;

Trait Implementations

impl Clone for UserManager

fn clone(&self) -> UserManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserManager

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

Formats the value using the given formatter.