Struct bonsaidb_core::admin::User

pub struct User {
    pub username: String,
    pub groups: Vec<u64>,
    pub roles: Vec<u64>,
    pub argon_hash: Option<SensitiveString>,
}

A user that can authenticate with BonsaiDb.

Fields

username: String

The name of the role. Must be unique.

groups: Vec<u64>

The IDs of the user groups this user belongs to.

roles: Vec<u64>

The IDs of the roles this user has been assigned.

argon_hash: Option<SensitiveString>

The user’s stored password hash.

This field is not feature gated to prevent losing stored passwords if the password-hashing feature is disabled and then re-enabled and user records are updated in the meantime.

Implementations

impl User

pub fn assume_identity<'name, Storage: StorageConnection>(
    name_or_id: impl Nameable<'name, u64>,
    storage: &Storage
) -> Result<Storage::Authenticated, Error>

pub async fn assume_identity_async<'name, Storage: AsyncStorageConnection>(
    name_or_id: impl Nameable<'name, u64> + Send,
    storage: &Storage
) -> Result<Storage::Authenticated, Error>

pub fn default_with_username(username: impl Into<String>) -> Self

Returns a default user with the given username.

pub fn effective_permissions<C: Connection>(
    &self,
    admin: &C,
    inherit_permissions: &Permissions
) -> Result<Permissions, Error>

Calculates the effective permissions based on the groups and roles this user is assigned.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Collection for User

type PrimaryKey = u64

The unique id type. Each document stored in a collection will be uniquely identified by this type.

fn collection_name() -> CollectionName

The unique name of this collection. Each collection must be uniquely named within the Schema it is registered within.

fn define_views(schema: &mut Schematic) -> Result<(), Error>

Defines all Views in this collection in schema.

fn encryption_key() -> Option<KeyId>

If a KeyId is returned, this collection will be stored encrypted at-rest using the key specified.

impl Debug for User

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

Formats the value using the given formatter.

impl Default for User

fn default() -> User

Returns the “default value” for a type.

impl DefaultSerialization for User

fn natural_id(&self) -> Option<Self::PrimaryKey>

Returns the natural identifier of contents. This is called when pushing values into a collection, before attempting to automatically assign a unique id.

impl<'de> Deserialize<'de> for User

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedCollection for User

type ByNameView = ByName

The name view defined for the collection.

fn load<'name, N: Nameable<'name, Self::PrimaryKey> + Send + Sync, C: Connection>(
    id: N,
    connection: &C
) -> Result<Option<CollectionDocument<Self>>, Error>where
    Self: SerializedCollection + Sized + 'static,

Gets a CollectionDocument with id from connection.

fn load_async<'name, 'life0, 'async_trait, N, C>(
    id: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<CollectionDocument<Self>>, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + 'static + Send + 'async_trait,
    N: 'async_trait + Nameable<'name, Self::PrimaryKey> + Send + Sync,
    C: 'async_trait + AsyncConnection,
    'name: 'async_trait,
    'life0: 'async_trait,

Gets a CollectionDocument with id from connection.

fn entry<'connection, 'name, N: Into<NamedReference<'name, Self::PrimaryKey>> + Send + Sync, C: Connection>(
    id: N,
    connection: &'connection C
) -> Entry<'connection, 'name, C, Self, (), ()>where
    Self: SerializedCollection + Sized,

Gets a CollectionDocument with id from connection.

fn entry_async<'connection, 'name, N: Into<NamedReference<'name, Self::PrimaryKey>> + Send + Sync, C: AsyncConnection>(
    id: N,
    connection: &'connection C
) -> AsyncEntry<'connection, 'name, C, Self, (), ()> where
    Self: SerializedCollection + Sized,

Gets a CollectionDocument with id from connection.

fn load_document<'name, N: Nameable<'name, Self::PrimaryKey> + Send + Sync, C: Connection>(
    name: N,
    connection: &C
) -> Result<Option<OwnedDocument>, Error>where
    Self: SerializedCollection + Sized,

Loads a document from this collection by name, if applicable. Return Ok(None) if unsupported.

fn load_document_async<'name, 'life0, 'async_trait, N, C>(
    name: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + Send + 'async_trait,
    N: 'async_trait + Nameable<'name, Self::PrimaryKey> + Send + Sync,
    C: 'async_trait + AsyncConnection,
    'name: 'async_trait,
    'life0: 'async_trait,

Loads a document from this collection by name, if applicable. Return Ok(None) if unsupported.

fn delete_by_name<C: Connection>(
    name: &str,
    connection: &C
) -> Result<bool, Error>where
    Self: SerializedCollection + Sized,

Deletes a document by its name. Returns true if a document was deleted.

fn delete_by_name_async<'life0, 'life1, 'async_trait, C>(
    name: &'life0 str,
    connection: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>where
    Self: SerializedCollection + Sized + Send + 'async_trait,
    C: 'async_trait + AsyncConnection,
    'life0: 'async_trait,
    'life1: 'async_trait,

Deletes a document by its name. Returns true if a document was deleted.

impl Serialize for User

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.