Struct bonsaidb_core::admin::Database

source · [−]

pub struct Database {
    pub name: String,
    pub schema: SchemaName,
}

Expand description

A database stored in BonsaiDb.

Fields

name: String

The name of the database.

schema: SchemaName

The schema defining the database.

Trait Implementations

source

impl Clone for Database

source

fn clone(&self) -> Database

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Collection for Database

type PrimaryKey = u64

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

source

fn collection_name() -> CollectionName

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

source

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

Defines all Views in this collection in schema.

source

fn encryption_key() -> Option<KeyId>

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

source

impl Debug for Database

source

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

Formats the value using the given formatter. Read more

source

impl DefaultSerialization for Database

source

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. Read more

source

impl<'de> Deserialize<'de> for Database

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl NamedCollection for Database

type ByNameView = ByName

The name view defined for the collection.

source

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

Gets a CollectionDocument with id from connection.

source

fn entry<'connection, 'name, N: Into<NamedReference<'name, Self::PrimaryKey>> + Send + Sync, C: Connection>(
 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 Col: NamedCollection + SerializedCollection + 'static, <Col as Collection>::PrimaryKey: Unpin, Conn: Connection, EI: EntryInsert<Col> + 'a, EU: EntryUpdate<Col> + 'a, 'name: 'a, type Output = Result<Option<CollectionDocument<Col>>, Error>;` where
 Self: SerializedCollection + Sized,

Gets a CollectionDocument with id from connection.

source

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

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

source

impl PartialEq<Database> for Database

source

fn eq(&self, other: &Database) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Database) -> bool

This method tests for !=.

source

impl Serialize for Database

source

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

Serialize this value into the given Serde serializer. Read more

source

impl StructuralPartialEq for Database

Auto Trait Implementations

impl RefUnwindSafe for Database

impl Send for Database

impl Sync for Database

impl Unpin for Database

impl UnwindSafe for Database

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

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

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

source

fn schema_name() -> SchemaName

Returns the unique SchemaName for this schema.

source

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

Defines the Collections into schema.

source

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

Retrieves the Schematic for this schema.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

Struct bonsaidb_core::admin::Database

Fields

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

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

impl Collection for Database

type PrimaryKey = u64

fn collection_name() -> CollectionName

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

fn encryption_key() -> Option<KeyId>

impl Debug for Database

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

impl DefaultSerialization for Database

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

impl<'de> Deserialize<'de> for Database

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

impl NamedCollection for Database

type ByNameView = ByName

impl PartialEq<Database> for Database

fn eq(&self, other: &Database) -> bool

fn ne(&self, other: &Database) -> bool

impl Serialize for Database

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

impl StructuralPartialEq for Database

Auto Trait Implementations

impl RefUnwindSafe for Database

impl Send for Database

impl Sync for Database

impl Unpin for Database

impl UnwindSafe for Database

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

fn schema_name() -> SchemaName

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

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

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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