deadpool_sqlite/
config.rs

1use std::{convert::Infallible, path::PathBuf};
2
3use crate::{CreatePoolError, Manager, Pool, PoolBuilder, PoolConfig, Runtime};
4
5/// Configuration object.
6///
7/// # Example (from environment)
8///
9/// By enabling the `serde` feature you can read the configuration using the
10/// [`config`](https://crates.io/crates/config) crate as following:
11/// ```env
12/// SQLITE__PATH=db.sqlite3
13/// SQLITE__POOL__MAX_SIZE=16
14/// SQLITE__POOL__TIMEOUTS__WAIT__SECS=5
15/// SQLITE__POOL__TIMEOUTS__WAIT__NANOS=0
16/// ```
17/// ```rust
18/// #[derive(serde::Deserialize, serde::Serialize)]
19/// struct Config {
20///     sqlite: deadpool_sqlite::Config,
21/// }
22/// impl Config {
23///     pub fn from_env() -> Result<Self, config::ConfigError> {
24///         let mut cfg = config::Config::builder()
25///            .add_source(config::Environment::default().separator("__"))
26///            .build()?;
27///            cfg.try_deserialize()
28///     }
29/// }
30/// ```
31#[derive(Clone, Debug, Default)]
32#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
33pub struct Config {
34    /// Path to SQLite database file.
35    pub path: PathBuf,
36
37    /// [`Pool`] configuration.
38    pub pool: Option<PoolConfig>,
39}
40
41impl Config {
42    /// Create a new [`Config`] with the given `path` of SQLite database file.
43    #[must_use]
44    pub fn new(path: impl Into<PathBuf>) -> Self {
45        Self {
46            path: path.into(),
47            pool: None,
48        }
49    }
50
51    /// Creates a new [`Pool`] using this [`Config`].
52    ///
53    /// # Errors
54    ///
55    /// See [`CreatePoolError`] for details.
56    ///
57    /// [`RedisError`]: redis::RedisError
58    pub fn create_pool(&self, runtime: Runtime) -> Result<Pool, CreatePoolError> {
59        self.builder(runtime)
60            .map_err(CreatePoolError::Config)?
61            .runtime(runtime)
62            .build()
63            .map_err(CreatePoolError::Build)
64    }
65
66    /// Creates a new [`PoolBuilder`] using this [`Config`].
67    ///
68    /// # Errors
69    ///
70    /// See [`ConfigError`] for details.
71    ///
72    /// [`RedisError`]: redis::RedisError
73    pub fn builder(&self, runtime: Runtime) -> Result<PoolBuilder, ConfigError> {
74        let manager = Manager::from_config(self, runtime);
75        Ok(Pool::builder(manager)
76            .config(self.get_pool_config())
77            .runtime(runtime))
78    }
79
80    /// Returns [`deadpool::managed::PoolConfig`] which can be used to construct
81    /// a [`deadpool::managed::Pool`] instance.
82    #[must_use]
83    pub fn get_pool_config(&self) -> PoolConfig {
84        self.pool.unwrap_or_default()
85    }
86}
87
88/// This error is returned if there is something wrong with the SQLite configuration.
89///
90/// This is just a type alias to [`Infallible`] at the moment as there
91/// is no validation happening at the configuration phase.
92pub type ConfigError = Infallible;
deadpool_sqlite/config.rs

deadpool_sqlite/
config.rs
