Struct bonsaidb_server::ServerConfiguration

#[non_exhaustive]
pub struct ServerConfiguration<B: Backend = NoBackend> {
    pub backend: B,
    pub server_name: String,
    pub client_simultaneous_request_limit: usize,
    pub request_workers: usize,
    pub storage: StorageConfiguration,
    pub default_permissions: DefaultPermissions,
    pub acme: AcmeConfiguration,
    /* private fields */
}

Configuration options for Server

Fields (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.

backend: B

The Backend for the server.

server_name: String

The DNS name of the server.

client_simultaneous_request_limit: usize

Number of sumultaneous requests a single client can have in flight at a time. Default value is 16. It is important to have this number be tuned relative to request_workers such that one client cannot overwhelm the entire queue.

request_workers: usize

Number of simultaneous requests to be processed. Default value is 16.

storage: StorageConfiguration

Configuration options for individual databases.

default_permissions: DefaultPermissions

The permissions granted to all connections to this server.

acme: AcmeConfiguration

The ACME settings for automatic TLS certificate management.

Implementations

impl<B: Backend> ServerConfiguration<B>

pub fn default_for(backend: B) -> Self

Returns a default configuration for the given backend.

pub fn new_with_backend<P: AsRef<Path>>(path: P, backend: B) -> Self

Returns a default configuration for the given backend and path.

pub fn server_name(self, server_name: impl Into<String>) -> Self

Sets Self::server_name to server_name and returns self.

pub const fn client_simultaneous_request_limit( self, request_limit: usize ) -> Self

Sets Self::client_simultaneous_request_limit to request_limit and returns self.

pub const fn request_workers(self, workers: usize) -> Self

Sets Self::request_workers to workers and returns self.

pub fn default_permissions<P: Into<DefaultPermissions>>( self, default_permissions: P ) -> Self

Sets Self::default_permissions to default_permissions and returns self.

pub fn acme_contact_email(self, contact_email: impl Into<String>) -> Self

Sets AcmeConfiguration::contact_email to contact_email and returns self.

pub fn acme_directory(self, directory: impl Into<String>) -> Self

Sets AcmeConfiguration::directory to directory and returns self.

pub fn register_custom_api<Dispatcher: Handler<Api, B> + 'static, Api: Api>( &mut self ) -> Result<(), Error>

Registers a handler for a [Api][api::Api]. When an [Api][api::Api] is received by the server, the handler will be invoked

pub fn with_api<Dispatcher: Handler<Api, B> + 'static, Api: Api>( self ) -> Result<Self, Error>

Registers the custom api dispatcher and returns self.

Trait Implementations

impl<B: Backend> Builder for ServerConfiguration<B>

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

Registers the schema and returns self.

fn memory_only(self) -> Self

Sets StorageConfiguration::memory_only to true and returns self.

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

Sets StorageConfiguration::path to path and returns self.

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

Sets StorageConfiguration::unique_id to unique_id and returns self.

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

Sets StorageConfiguration::vault_key_storage to key_storage and returns self.

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

Sets StorageConfiguration::default_encryption_key to path and returns self.

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

Sets [Tasks::worker_count] to worker_count and returns self.

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

Sets [Tasks::parallelization] to parallelization and returns self.

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

Sets [Views::check_integrity_on_open] to check and returns self.

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

Sets StorageConfiguration::default_compression to path and returns self.

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

Sets StorageConfiguration::key_value_persistence to persistence and returns self.

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

Sets Self::authenticated_permissions to authenticated_permissions and returns self.

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

Sets StorageConfiguration::argon to argon and returns self.

impl<B: Clone + Backend> Clone for ServerConfiguration<B>

fn clone(&self) -> ServerConfiguration<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Backend> Debug for ServerConfiguration<B>

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

Formats the value using the given formatter.

impl<B> Default for ServerConfiguration<B>where B: Backend + Default,

fn default() -> Self

Returns the “default value” for a type.