#[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 */ }
Expand description

Configuration options for Server

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

source§

impl<B: Backend> ServerConfiguration<B>

source

pub fn default_for(backend: B) -> Self

Returns a default configuration for the given backend.

source

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

Returns a default configuration for the given backend and path.

source

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

Sets Self::server_name to server_name and returns self.

source

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

Sets Self::client_simultaneous_request_limit to request_limit and returns self.

source

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

Sets Self::request_workers to workers and returns self.

source

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

Sets Self::default_permissions to default_permissions and returns self.

source

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

Sets AcmeConfiguration::contact_email to contact_email and returns self.

source

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

Sets AcmeConfiguration::directory to directory and returns self.

source

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

source

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§

source§

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

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 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 default_compression(self, compression: Compression) -> Self

Sets StorageConfiguration::default_compression to path 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§

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

source§

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

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

source§

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

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

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

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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