Struct Configured 

pub struct Configured { /* private fields */ }

Base implementation of configurable objects

This is a base structure that implements the Configurable trait and can be used as a base for other structures that need configuration.

Features

• Automatically implements the Configurable trait
• Provides configuration change callback mechanism
• Can be inherited and extended

Examples

use qubit_config::{Config, Configured};

let mut configured = Configured::new();
configured.config_mut().set("port", 8080)?;
let port: i32 = configured.config().get("port")?;
assert_eq!(port, 8080);

// Or compose it into other structures
struct Server {
    configured: Configured,
    // Other fields...
}

impl Server {
    fn new() -> Self {
        Self {
            configured: Configured::new(),
        }
    }

    fn config(&self) -> &Config {
        self.configured.config()
    }

    fn config_mut(&mut self) -> &mut Config {
        self.configured.config_mut()
    }
}

Author

Haixing Hu

Implementations

impl Configured

pub fn new() -> Self

Creates a new configurable object

Returns

Returns a new configurable object instance

Examples

use common_rs::util::config::Configured;

let configured = Configured::new();
assert!(configured.config().is_empty());

pub fn with_config(config: Config) -> Self

Creates a configurable object with the specified configuration

Parameters

• config - Configuration object

Returns

Returns a new configurable object instance

Examples

use common_rs::util::config::{Config, Configured};

let mut configured = Configured::with_config(Config::new());
assert!(configured.config().is_empty());

Trait Implementations

impl Clone for Configured

fn clone(&self) -> Configured

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for Configured

fn config(&self) -> &Config

Gets a reference to the configuration

fn config_mut(&mut self) -> &mut Config

Gets a mutable reference to the configuration

fn set_config(&mut self, config: Config)

Sets the configuration

fn on_config_changed(&mut self)

Callback after configuration changes

impl Debug for Configured

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

Formats the value using the given formatter.

impl Default for Configured

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Configured

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