Skip to main content

InstallConfig

Struct InstallConfig 

Source
pub struct InstallConfig { /* private fields */ }
Expand description

The fixed configuration for a Witchcraft server.

Implementations§

Source§

impl InstallConfig

Source

pub fn builder() -> Builder<ProductNameStage>

Returns a new builder.

Source§

impl InstallConfig

Source

pub fn product_name(&self) -> &str

Returns the service’s name.

Required.

Source

pub fn product_version(&self) -> &str

Returns the service’s version.

Required.

Source

pub fn port(&self) -> u16

Returns the port the server will listen on.

Required.

Source

pub fn management_port(&self) -> Option<u16>

Returns the port that the server’s management APIs will listen on.

Defaults to port().

Source

pub fn keystore(&self) -> &KeystoreConfig

Returns the server’s TLS key configuration.

Source

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.

Source

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

Source

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.

Source

pub fn server(&self) -> &ServerConfig

Returns advanced server settings.

Source

pub fn minidump(&self) -> &MinidumpConfig

Returns minidump settings.

Trait Implementations§

Source§

impl AsRef<InstallConfig> for InstallConfig

Source§

fn as_ref(&self) -> &InstallConfig

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

impl Clone for InstallConfig

Source§

fn clone(&self) -> InstallConfig

Returns a duplicate 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 InstallConfig

Source§

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

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

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for InstallConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Validate for InstallConfig

Source§

type Error = ConfigError

The error returned for an invalid value.
Source§

fn validate(&self) -> Result<(), Self::Error>

Validates the state of self.
Source§

impl StructuralPartialEq for InstallConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,