Struct bonsaidb::core::admin::User

source · [−]

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

Expand description

A user that can authenticate with BonsaiDb.

Fields

username: String

The name of the role. Must be unique.

groups: Vec<u64, Global>

The IDs of the user groups this user belongs to.

roles: Vec<u64, Global>

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 default_with_username(username: impl Into<String>) -> User

Returns a default user with the given username.

pub async fn effective_permissions<C>(
    &'_ self,
    admin: &'_ C
) -> Result<Permissions, Error> where
    C: Connection,

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

Trait Implementations

impl Collection for User

pub fn encryption_key() -> Option<KeyId>

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

pub fn collection_name() -> CollectionName

The Id of this collection.

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

Defines all Views in this collection in schema.

impl Debug for User

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

Formats the value using the given formatter. Read more

impl Default for User

pub fn default() -> User

Returns the “default value” for a type. Read more

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

pub fn deserialize<D>(
deserializer: D
) -> Result<User, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl NamedCollection for User

type ByNameView = ByName

The name view defined for the collection.

fn load<'name, 'life0, 'async_trait, N, C>(
    id: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<CollectionDocument<Self>>, Error>> + Send + 'async_trait, Global>> where
    'name: 'async_trait,
    'life0: 'async_trait,
    N: Into<NamedReference<'name>> + Send + Sync + 'async_trait,
    C: Connection + 'async_trait,
    Self: 'static + SerializedCollection + 'async_trait + Send,

Gets a CollectionDocument with id from connection.

fn entry<'name, N, C>(
    id: N,
    connection: &'connection C
) -> Entry<'connection, 'name, C, Self, (), ()>ⓘ
Notable traits for Entry<'a, 'name, Conn, Col, EI, EU>
`impl<'a, 'name, Conn, Col, EI, EU> Future for Entry<'a, 'name, Conn, Col, EI, EU> where     'name: 'a,     Col: 'static + NamedCollection + SerializedCollection,     Conn: Connection,     EI: 'a + EntryInsert<Col>,     EU: 'a + EntryUpdate<Col>, type Output = Result<Option<CollectionDocument<Col>>, Error>;`
where
    N: Into<NamedReference<'name>> + Send + Sync,
    C: Connection,
    Self: SerializedCollection,

Gets a CollectionDocument with id from connection.

fn load_document<'name, 'life0, 'async_trait, N, C>(
    name: N,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedDocument>, Error>> + Send + 'async_trait, Global>> where
    'name: 'async_trait,
    'life0: 'async_trait,
    N: Into<NamedReference<'name>> + Send + Sync + 'async_trait,
    C: Connection + 'async_trait,
    Self: SerializedCollection + 'async_trait + Send,

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

impl Serialize for User

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl DefaultSerialization for User

Auto Trait Implementations

impl RefUnwindSafe for User

impl Send for User

impl Sync for User

impl Unpin for User

impl UnwindSafe for User

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Schema for T where
T: 'static + Collection,

pub fn schema_name() -> SchemaName

Returns the unique SchemaName for this schema.

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

Defines the Collections into schema.

fn schematic() -> Result<Schematic, Error>

Retrieves the Schematic for this schema.

impl<T> SerializedCollection for T where
T: DefaultSerialization + Serialize + DeserializeOwned,

type Contents = T

The type of the contents stored in documents in this collection.

type Format = Pot

The serialization format for this collection.

pub fn format() -> <T as SerializedCollection>::Format

Returns the configured instance of Self::Format.

fn deserialize(data: &[u8 ]) -> Result<Self::Contents, Error>

Deserialize data as Self::Contents using this collection’s format.

fn serialize(item: &Self::Contents) -> Result<Vec<u8, Global>, Error>

Serialize item using this collection’s format.

fn get<'life0, 'async_trait, C>(
    id: u64,
    connection: &'life0 C
) -> Pin<Box<dyn Future<Output = Result<Option<CollectionDocument<Self>>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    C: Connection + 'async_trait,
    Self: 'async_trait + Send,

Gets a CollectionDocument with id from connection.

fn get_multiple<'life0, 'life1, 'async_trait, C>(
    ids: &'life0 [u64 ],
    connection: &'life1 C
) -> Pin<Box<dyn Future<Output = Result<Vec<CollectionDocument<Self>, Global>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    C: Connection + 'async_trait,
    Self: 'async_trait + Send,

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated. Read more

fn list<R, C>(ids: R, connection: &C) -> List<'_, C, Self>ⓘ
Notable traits for List<'a, Cn, Cl>
`impl<'a, Cn, Cl> Future for List<'a, Cn, Cl> where     Cl: SerializedCollection + Unpin,     Cn: Connection, type Output = Result<Vec<CollectionDocument<Cl>, Global>, Error>;`
where
    R: Into<Range<u64>>,
    C: Connection,

Retrieves all documents matching ids. Documents that are not found are not returned, but no error will be generated. Read more

fn push<'life0, 'async_trait, Cn>(
    contents: Self::Contents,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self::Contents>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Cn: Connection + 'async_trait,
    Self: 'static + 'async_trait + Send,
    Self::Contents: 'async_trait,

Pushes this value into the collection, returning the created document.

fn push_into<'life0, 'async_trait, Cn>(
    self,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Cn: Connection + 'async_trait,
    Self: 'static + SerializedCollection<Contents = Self> + 'async_trait + Send,

Pushes this value into the collection, returning the created document.

fn insert<'life0, 'async_trait, Cn>(
    id: u64,
    contents: Self::Contents,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self::Contents>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Cn: Connection + 'async_trait,
    Self: 'static + 'async_trait + Send,
    Self::Contents: 'async_trait,

Inserts this value into the collection with the specified id, returning the created document. Read more

fn insert_into<'life0, 'async_trait, Cn>(
    self,
    id: u64,
    connection: &'life0 Cn
) -> Pin<Box<dyn Future<Output = Result<CollectionDocument<Self>, InsertError<Self>>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Cn: Connection + 'async_trait,
    Self: 'static + SerializedCollection<Contents = Self> + 'async_trait + Send,

Inserts this value into the collection with the given id, returning the created document. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,