Struct Settings

pub struct Settings {
    pub mode: Mode,
    pub name: String,
    pub network: NetworkConfig,
    pub scope: Scope,
    pub services: ServicesConfig,
    pub version: String,
    pub worker: Vec<WorkerConfig>,
}

Fields

mode: Mode

name: String

network: NetworkConfig

scope: Scope

services: ServicesConfig

version: String

worker: Vec<WorkerConfig>

Implementations

impl Settings

pub fn new(mode: Mode) -> Self

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

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

pub fn init_tracing(&self)

Initialize tracing modules

pub fn debug(self) -> Self

Returns a new Settings instance with the Mode set to Mode::Debug.

pub fn release(self) -> Self

Returns a new Settings instance with the Mode set to Mode::Release.

pub fn mode(&self) -> &Mode

pub fn mode_mut(&mut self) -> &mut Mode

pub fn name(&self) -> &String

pub fn name_mut(&mut self) -> &mut String

pub fn network(&self) -> &NetworkConfig

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

pub fn scope(&self) -> &Scope

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

pub fn services(&self) -> &ServicesConfig

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

pub fn version(&self) -> &String

pub fn version_mut(&mut self) -> &mut String

pub fn set_mode(&mut self, mode: Mode)

pub fn with_mode(self, mode: Mode) -> Self

pub fn set_name(&mut self, name: impl ToString)

pub fn with_name(self, name: impl ToString) -> Self

pub fn set_scope(&mut self, scope: Scope)

pub fn with_scope(self, scope: Scope) -> Self

pub fn set_network(&mut self, network: NetworkConfig)

pub fn with_network(self, network: NetworkConfig) -> Self

pub fn set_services(&mut self, services: ServicesConfig)

pub fn with_services(self, services: ServicesConfig) -> Self

pub fn set_version(&mut self, version: impl ToString)

pub fn with_version(self, version: impl ToString) -> Self

pub fn workers(&self) -> &[WorkerConfig]

Returns an immutable reference to the worker configuration.

pub fn workers_mut(&mut self) -> &mut Vec<WorkerConfig>

Returns a mutable reference to the worker configuration.

pub fn push_worker(&mut self, worker: WorkerConfig)

Push a new worker configuration to the worker configuration list.

pub fn set_workdir(&mut self, workdir: impl ToString)

set the working directory of the scope

pub fn set_some_workdir(&mut self, workdir: Option<impl ToString>)

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

pub fn set_scope_context(&mut self, context: impl ToString)

Set the context of the scope

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 FromRef<Context> for Settings

fn from_ref(ctx: &Context) -> Self

Converts to this type from a reference to the input type.

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