Struct CommonConfig

pub struct CommonConfig {
    pub env: Environment,
    pub num_async_threads: usize,
    pub num_blocking_threads: usize,
    pub tracing: TracingConfig,
    pub sentry: Option<SentryConfig>,
    pub metrics: MetricsConfig,
    pub nocapture: bool,
    pub unknown_client_enabled: bool,
}

Configuration that can be used by any binary.

Fields

env: Environment

Environment where the application is running.

num_async_threads: usize

Number of threads to execute global async tasks.

num_blocking_threads: usize

Number of threads to execute global blocking tasks.

tracing: TracingConfig

sentry: Option<SentryConfig>

metrics: MetricsConfig

nocapture: bool

Prevents clap from breaking when passing nocapture options in tests.

unknown_client_enabled: bool

Enables or disables unknown client interactions.

Implementations

impl CommonConfig

pub fn init_tokio_runtime(&self) -> Result<Runtime>

Initializes Tokio runtime.

Trait Implementations

impl Args for CommonConfig

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for CommonConfig

fn clone(&self) -> CommonConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CommonConfig

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CommonConfig

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

Formats the value using the given formatter.

impl FromArgMatches for CommonConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CommonConfig

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for CommonConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WithCommonConfig for CommonConfig

fn common(&self) -> &CommonConfig