Struct AppConfig

pub struct AppConfig {
    pub app_name: Stringy,
    pub version: String,
    pub max_ram_usage: usize,
    pub max_cpu_usage: usize,
    pub environment: String,
    pub debug_mode: bool,
    pub log_level: LogLevel,
    pub git: Option<GitConfig>,
    pub database: Option<DatabaseConfig>,
    pub aggregator: Option<Aggregator>,
}

Represents the application’s configuration settings.

Fields

app_name: Stringy

A name for the application instance.

version: String

Version of the application.

max_ram_usage: usize

Maximum ram usage in MB

max_cpu_usage: usize

Maximum cpu time usage This would be practically be used to restart a service when it gets to it’s aloted cpu time. A pricing scale be set like this.

environment: String

The environment the application is running in (e.g., development, staging, production).

debug_mode: bool

Optional setting for enabling debug mode.

log_level: LogLevel

Settings for what information is logged

git: Option<GitConfig>

Configuration related to the Git functionality.

database: Option<DatabaseConfig>

Configuration related to the database (optional example).

aggregator: Option<Aggregator>

Configuration for Aggregator communication

Implementations

impl AppConfig

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

Loads the configuration from files and environment variables using ConfigBuilder.

Returns

Returns an AppConfig instance if successful.

Errors

Returns a ConfigError if loading or parsing the configuration fails.

pub fn validate(&self) -> Result<(), String>

Validates the configuration values.

Returns

Returns Ok(()) if validation passes.

Errors

Returns a String with an error message if validation fails.

pub fn get_version(&self) -> Result<SoftwareVersion, ErrorArrayItem>

Trait Implementations

impl Clone for AppConfig

fn clone(&self) -> AppConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AppConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AppConfig

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

Formats the value using the given formatter.

impl Ord for AppConfig

fn cmp(&self, other: &AppConfig) -> 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 AppConfig

fn eq(&self, other: &AppConfig) -> 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 AppConfig

fn partial_cmp(&self, other: &AppConfig) -> 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 AppConfig

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 AppConfig

impl StructuralPartialEq for AppConfig