Struct Config

pub struct Config {
    pub path: PathBuf,
    pub pool: Option<PoolConfig>,
}

Configuration object.

Example (from environment)

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

SQLITE__PATH=db.sqlite3
SQLITE__POOL__MAX_SIZE=16
SQLITE__POOL__TIMEOUTS__WAIT__SECS=5
SQLITE__POOL__TIMEOUTS__WAIT__NANOS=0

#[derive(serde::Deserialize, serde::Serialize)]
struct Config {
    sqlite: deadpool_sqlite::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 SQLite database file.

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 SQLite database file.

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 copy 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() -> Config

Returns the “default value” for a type.