Struct bonsaidb::server::ServerConfiguration

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

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.

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> ServerConfiguration<B> where
    B: Backend, 

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

Sets Self::server_name to server_name and returns self.

pub fn client_simultaneous_request_limit(
    self,
    request_limit: usize
) -> ServerConfiguration<B>

Sets Self::client_simultaneous_request_limit to request_limit and returns self.

pub fn request_workers(self, workers: usize) -> ServerConfiguration<B>

Sets Self::request_workers to workers and returns self.

pub fn default_permissions<P>(
    self,
    default_permissions: P
) -> ServerConfiguration<B> where
    P: Into<DefaultPermissions>, 

Sets Self::default_permissions to default_permissions and returns self.

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

Sets AcmeConfiguration::contact_email to contact_email and returns self.

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

Sets AcmeConfiguration::directory to directory and returns self.

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

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

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

Registers the custom api dispatcher and returns self.

Trait Implementations

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

pub fn with_schema<S>(self) -> Result<ServerConfiguration<B>, Error> where
    S: Schema, 

Registers the schema and returns self.

pub fn memory_only(self) -> ServerConfiguration<B>

Sets StorageConfiguration::path to true and returns self.

pub fn path<P>(self, path: P) -> ServerConfiguration<B> where
    P: AsRef<Path>, 

Sets StorageConfiguration::path to path and returns self.

pub fn unique_id(self, unique_id: u64) -> ServerConfiguration<B>

Sets StorageConfiguration::unique_id to unique_id and returns self.

pub fn vault_key_storage<VaultKeyStorage>(
    self,
    key_storage: VaultKeyStorage
) -> ServerConfiguration<B> where
    VaultKeyStorage: AnyVaultKeyStorage, 

Sets StorageConfiguration::vault_key_storage to key_storage and returns self.

pub fn default_encryption_key(self, key: KeyId) -> ServerConfiguration<B>

Sets StorageConfiguration::default_encryption_key to path and returns self.

pub fn tasks_worker_count(self, worker_count: usize) -> ServerConfiguration<B>

Sets Tasks::worker_count to worker_count and returns self.

pub fn tasks_parallelization(
    self,
    parallelization: usize
) -> ServerConfiguration<B>

Sets Tasks::parallelization to parallelization and returns self.

pub fn check_view_integrity_on_open(self, check: bool) -> ServerConfiguration<B>

Sets Views::check_integrity_on_open to check and returns self.

pub fn default_compression(
    self,
    compression: Compression
) -> ServerConfiguration<B>

Sets StorageConfiguration::default_compression to path and returns self.

pub fn key_value_persistence(
    self,
    persistence: KeyValuePersistence
) -> ServerConfiguration<B>

Sets StorageConfiguration::key_value_persistence to persistence and returns self.

pub fn authenticated_permissions<P>(
    self,
    authenticated_permissions: P
) -> ServerConfiguration<B> where
    P: Into<Permissions>, 

Sets Self::authenticated_permissions to authenticated_permissions and returns self.

pub fn argon(self, argon: ArgonConfiguration) -> ServerConfiguration<B>

Sets StorageConfiguration::argon to argon and returns self.

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

Creates a default configuration with path set.

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

pub 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 for ServerConfiguration<B> where
    B: Debug + Backend, 

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

Formats the value using the given formatter.

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

pub fn default() -> ServerConfiguration<B>

Returns the “default value” for a type.