#[non_exhaustive]
pub struct StorageConfiguration { pub path: Option<PathBuf>, pub memory_only: bool, pub unique_id: Option<u64>, pub vault_key_storage: Option<Arc<dyn AnyVaultKeyStorage>>, pub default_encryption_key: Option<KeyId>, pub workers: Tasks, pub views: Views, pub key_value_persistence: KeyValuePersistence, pub default_compression: Option<Compression>, pub authenticated_permissions: Permissions, pub argon: ArgonConfiguration, /* private fields */ }
Expand description

Configuration options for Storage.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§path: Option<PathBuf>

The path to the database. Defaults to db.bonsaidb if not specified.

§memory_only: bool

Prevents storing data on the disk. This is intended for testing purposes primarily. Keep in mind that the underlying storage format is append-only.

§unique_id: Option<u64>

The unique id of the server. If not specified, the server will randomly generate a unique id on startup. If the server generated an id and this value is subsequently set, the generated id will be overridden by the one specified here.

§vault_key_storage: Option<Arc<dyn AnyVaultKeyStorage>>

The vault key storage to use. If not specified, LocalVaultKeyStorage will be used with the server’s data folder as the path. This is incredibly insecure and should not be used outside of testing.

For secure encryption, it is important to store the vault keys in a location that is separate from the database. If the keys are on the same hardware as the encrypted content, anyone with access to the disk will be able to decrypt the stored data.

§default_encryption_key: Option<KeyId>

The default encryption key for the database. If specified, all documents will be stored encrypted at-rest using the key specified. Having this key specified will also encrypt views. Without this, views will be stored unencrypted.

§workers: Tasks

Configuration options related to background tasks.

§views: Views

Configuration options related to views.

§key_value_persistence: KeyValuePersistence

Controls how the key-value store persists keys, on a per-database basis.

§default_compression: Option<Compression>

Sets the default compression algorithm.

§authenticated_permissions: Permissions

The permissions granted to authenticated connections to this server.

§argon: ArgonConfiguration

Password hashing configuration.

Implementations§

source§

impl StorageConfiguration

source

pub fn register_schema<S: Schema>(&mut self) -> Result<(), Error>

Registers the schema provided.

Trait Implementations§

source§

impl Builder for StorageConfiguration

source§

fn with_schema<S: Schema>(self) -> Result<Self, Error>

Registers the schema and returns self.
source§

fn memory_only(self) -> Self

Sets StorageConfiguration::memory_only to true and returns self.
source§

fn path<P: AsRef<Path>>(self, path: P) -> Self

Sets StorageConfiguration::path to path and returns self.
source§

fn unique_id(self, unique_id: u64) -> Self

Sets StorageConfiguration::unique_id to unique_id and returns self.
source§

fn vault_key_storage<VaultKeyStorage: AnyVaultKeyStorage>( self, key_storage: VaultKeyStorage ) -> Self

Sets StorageConfiguration::vault_key_storage to key_storage and returns self.
source§

fn default_encryption_key(self, key: KeyId) -> Self

Sets StorageConfiguration::default_encryption_key to path and returns self.
source§

fn default_compression(self, compression: Compression) -> Self

Sets StorageConfiguration::default_compression to path and returns self.
source§

fn tasks_worker_count(self, worker_count: usize) -> Self

Sets Tasks::worker_count to worker_count and returns self.
source§

fn tasks_parallelization(self, parallelization: usize) -> Self

Sets Tasks::parallelization to parallelization and returns self.
source§

fn check_view_integrity_on_open(self, check: bool) -> Self

Sets Views::check_integrity_on_open to check and returns self.
source§

fn key_value_persistence(self, persistence: KeyValuePersistence) -> Self

Sets StorageConfiguration::key_value_persistence to persistence and returns self.
source§

fn authenticated_permissions<P: Into<Permissions>>( self, authenticated_permissions: P ) -> Self

Sets Self::authenticated_permissions to authenticated_permissions and returns self.
source§

fn argon(self, argon: ArgonConfiguration) -> Self

Sets StorageConfiguration::argon to argon and returns self.
source§

fn new<P: AsRef<Path>>(path: P) -> Selfwhere Self: Default,

Creates a default configuration with path set.
source§

impl Clone for StorageConfiguration

source§

fn clone(&self) -> StorageConfiguration

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 Debug for StorageConfiguration

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for StorageConfiguration

source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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