Struct witchcraft_server::config::install::InstallConfig

pub struct InstallConfig { /* private fields */ }

The fixed configuration for a Witchcraft server.

Implementations

impl InstallConfig

pub fn builder() -> BuilderProductNameStage

Returns a new builder.

impl InstallConfig

pub fn product_name(&self) -> &str

Returns the service’s name.

Required.

pub fn product_version(&self) -> &str

Returns the service’s version.

Required.

pub fn port(&self) -> u16

Returns the port the server will listen on.

Required.

pub fn keystore(&self) -> &KeystoreConfig

Returns the server’s TLS key configuration.

pub fn client_auth_truststore(&self) -> Option<&ClientAuthTruststoreConfig>

Returns the server’s TLS client authentication truststore configuration.

If set, the server will request (but not require) the client to authenticate itself during the TLS handshake. If a certificate is present and validated against the trust roots, all requests made over that connection will include a ClientCertificate extension.

Defaults to None.

pub fn context_path(&self) -> &str

Returns the server’s context path.

This must either be equal to / or start but not end with a /.

Defaults to /.

pub fn use_console_log(&self) -> bool

If true, the server will log to standard output rather than to files.

Defaults to true if running in a container and false otherwise.

pub fn server(&self) -> &ServerConfig

Returns advanced server settings.

Trait Implementations

impl AsRef<InstallConfig> for InstallConfig

fn as_ref(&self) -> &InstallConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for InstallConfig

fn clone(&self) -> InstallConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstallConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstallConfig

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<InstallConfig> for InstallConfig

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Validate for InstallConfig

type Error = ConfigError

The error returned for an invalid value.

fn validate(&self) -> Result<(), <InstallConfig as Validate>::Error>

Validates the state of self.

impl StructuralPartialEq for InstallConfig