Skip to main content

BackboneConfig

Struct BackboneConfig 

Source
pub struct BackboneConfig {
    pub app: AppConfig,
    pub server: ServerConfig,
    pub database: HashMap<String, DatabaseConfig>,
    pub cache: HashMap<String, CacheConfig>,
    pub modules: ModulesConfig,
    pub logging: LoggingConfig,
    pub monitoring: MonitoringConfig,
    pub contexts: ContextsConfig,
    pub features: FeaturesConfig,
    pub security: SecurityConfig,
}
Expand description

Main configuration struct for Backbone Framework

Contains all configuration sections needed to run a Backbone application. Supports loading from YAML, TOML, or JSON files with environment variable substitution.

Fields§

§app: AppConfig

Application metadata

§server: ServerConfig

Server configuration

§database: HashMap<String, DatabaseConfig>

Database configurations (keyed by name)

§cache: HashMap<String, CacheConfig>

Cache configurations (keyed by name)

§modules: ModulesConfig

Module configurations

§logging: LoggingConfig

Logging configuration

§monitoring: MonitoringConfig

Monitoring configuration

§contexts: ContextsConfig

Cross-context communication

§features: FeaturesConfig

Feature flags

§security: SecurityConfig

Security settings

Implementations§

Source§

impl BackboneConfig

Source

pub fn from_file<P: AsRef<Path>>(path: P) -> ConfigResult<Self>

Load configuration from a file path

Supports YAML (.yml, .yaml), TOML (.toml), and JSON (.json) formats. Environment variables in the format ${VAR:default} are substituted.

§Example
ⓘ
let config = BackboneConfig::from_file("config/application.yml")?;
Source

pub fn from_file_with_env<P: AsRef<Path>>( base_path: P, env: &str, ) -> ConfigResult<Self>

Load configuration with environment-specific overrides

Loads base config from {base_path} and merges with {base_path}-{env}.{ext} if it exists.

§Example
ⓘ
// Loads config/application.yml + config/application-development.yml
let config = BackboneConfig::from_file_with_env(
    "config/application.yml",
    "development"
)?;
Source

pub fn from_env() -> ConfigResult<Self>

Load configuration from environment variables only

Uses default values and overrides with environment variables.

Source

pub fn validate(&self) -> ConfigResult<()>

Validate the configuration

Returns an error if any critical configuration is invalid.

Source

pub fn default_database(&self) -> Option<&DatabaseConfig>

Get the default database configuration

Source

pub fn get_database(&self, name: &str) -> Option<&DatabaseConfig>

Get a database configuration by name

Source

pub fn default_cache(&self) -> Option<&CacheConfig>

Get the default cache configuration

Source

pub fn get_cache(&self, name: &str) -> Option<&CacheConfig>

Get a cache configuration by name

Source

pub fn is_module_enabled(&self, module_name: &str) -> bool

Check if a module is enabled

Source

pub fn environment(&self) -> &Environment

Get the current environment

Source

pub fn is_production(&self) -> bool

Check if running in production

Source

pub fn is_development(&self) -> bool

Check if running in development

Source

pub fn is_debug(&self) -> bool

Check if debug mode is enabled

Source

pub fn merge(self, other: Self) -> Self

Merge another configuration into this one

Values from other override values in self.

Trait Implementations§

Source§

impl Clone for BackboneConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackboneConfig

Source§

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

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

impl Default for BackboneConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BackboneConfig

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 Serialize for BackboneConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

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

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more