Struct Settings 

pub struct Settings {
    pub mode: Mode,
    pub name: String,
    pub network: NetworkConfig,
    pub scope: Scope,
    pub services: ServicesConfig,
    pub version: String,
    pub workspace: WorkspaceConfig,
}

Fields

mode: Mode

name: String

network: NetworkConfig

scope: Scope

services: ServicesConfig

version: String

workspace: WorkspaceConfig

Implementations

impl Settings

pub const DEFAULT_MODE: Mode = Mode::Debug

pub const APP_NAME: &'static str = "arachnid"

pub fn new() -> Self

attempts to initialize a build a new instance of the configuration, falling back to the logical default if unsuccessful

pub fn from_mode(mode: Mode) -> Self

initialize a new instance of the settings from the given Mode

pub fn debug(self) -> Self

consumes the current instance to create another in Debug mode

pub fn release(self) -> Self

consumes the current instance to create another in Release mode

pub fn build() -> Result<Self, ConfigError>

tries to build the settings from the configuration sources

pub const fn mode(&self) -> Mode

returns a copy of the configured Mode

pub fn name(&self) -> &str

returns a reference to the application name

pub const fn network(&self) -> &NetworkConfig

returns a reference to the network configuration

pub const fn network_mut(&mut self) -> &mut NetworkConfig

returns a mutable reference to the network configuration

pub const fn scope(&self) -> &Scope

returns a reference to the current scope

pub const fn scope_mut(&mut self) -> &mut Scope

returns a mutable reference to the current scope

pub const fn services(&self) -> &ServicesConfig

returns a reference to the services

pub const fn services_mut(&mut self) -> &mut ServicesConfig

returns a mutable reference to the services

pub fn version(&self) -> &str

returns the version of the application

pub const fn workspace(&self) -> &WorkspaceConfig

returns a reference to the workspace

pub const fn workspace_mut(&mut self) -> &mut WorkspaceConfig

returns a mutable reference to the workspace

pub async fn bind(&self) -> Result<TcpListener>

attempts to bind a TcpListener to the configured network address.

pub fn init_tracing(&self)

Initialize tracing modules

pub fn set_workdir<T>(&mut self, workdir: T)

where PathBuf: From<T>,

set the working directory of the scope

pub fn set_workdir_option<T>(&mut self, workdir: Option<T>)

where PathBuf: From<T>,

if the workdir is set, set it to the given workdir

pub fn set_port(&mut self, port: u16)

pub fn set_log_level(&mut self, level: LogLevel)

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

where Settings: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Settings

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

Formats the value using the given formatter.

impl Hash for Settings

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Settings

fn cmp(&self, other: &Settings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Settings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Settings

fn partial_cmp(&self, other: &Settings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Settings

impl StructuralPartialEq for Settings