Struct Config 

pub struct Config {
    pub path: PathBuf,
    pub durability: DurabilityLevel,
    pub drop_if_exists: bool,
    pub pool: Option<PoolConfig>,
}

Configuration object for deadpool-apexbase.

Example (from environment)

By enabling the serde feature you can read the configuration using the config crate as following:

APEXBASE__PATH=/tmp/apex_db
APEXBASE__POOL__MAX_SIZE=16
APEXBASE__POOL__TIMEOUTS__WAIT__SECS=5
APEXBASE__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize, serde::Serialize)]
struct Config {
    apexbase: deadpool_apexbase::Config,
}
impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        let mut cfg = config::Config::builder()
           .add_source(config::Environment::default().separator("__"))
           .build()?;
           cfg.try_deserialize()
    }
}

Fields

path: PathBuf

Path to the ApexBase database directory.

durability: DurabilityLevel

Durability level for the database.

Default: DurabilityLevel::Safe

drop_if_exists: bool

Whether to drop existing .apex files when opening.

Default: false

pool: Option<PoolConfig>

Pool configuration.

Implementations

impl Config

pub fn new(path: impl Into<PathBuf>) -> Self

Create a new Config with the given path of the database directory.

pub fn create_pool(&self, runtime: Runtime) -> Result<Pool, CreatePoolError>

Creates a new Pool using this Config.

Errors

See CreatePoolError for details.

pub fn builder(&self, runtime: Runtime) -> Result<PoolBuilder, ConfigError>

Creates a new PoolBuilder using this Config.

Errors

See ConfigError for details.

pub fn get_pool_config(&self) -> PoolConfig

Returns deadpool::managed::PoolConfig which can be used to construct a deadpool::managed::Pool instance.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.