Struct DatabaseConfig 

#[non_exhaustive]
pub struct DatabaseConfig {
    pub engine: String,
    pub name: String,
    pub user: Option<String>,
    pub password: Option<SecretString>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub options: HashMap<String, String>,
}

Available on crate feature conf and non-WebAssembly only.

Database configuration

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

engine: String

Database engine/backend

name: String

Database name or path

user: Option<String>

Database user (if applicable)

password: Option<SecretString>

Database password (if applicable) - stored as SecretString to prevent accidental exposure

host: Option<String>

Database host (if applicable)

port: Option<u16>

Database port (if applicable)

options: HashMap<String, String>

Additional options

Implementations

impl DatabaseConfig

pub fn new(engine: impl Into<String>, name: impl Into<String>) -> DatabaseConfig

Available on crate feature core only.

Create a new database configuration with the given engine and name

Examples

use reinhardt_conf::settings::DatabaseConfig;

let db = DatabaseConfig::new("reinhardt.db.backends.sqlite3", "myapp.db");
assert_eq!(db.engine, "reinhardt.db.backends.sqlite3");
assert_eq!(db.name, "myapp.db");

pub fn with_user(self, user: impl Into<String>) -> DatabaseConfig

Available on crate feature core only.

Set the user for this database configuration

pub fn with_password(self, password: impl Into<String>) -> DatabaseConfig

Available on crate feature core only.

Set the password for this database configuration

pub fn with_host(self, host: impl Into<String>) -> DatabaseConfig

Available on crate feature core only.

Set the host for this database configuration

pub fn with_port(self, port: u16) -> DatabaseConfig

Available on crate feature core only.

Set the port for this database configuration

pub fn sqlite(name: impl Into<String>) -> DatabaseConfig

Available on crate feature core only.

Create a SQLite database configuration

Examples

use reinhardt_conf::settings::DatabaseConfig;

let db = DatabaseConfig::sqlite("myapp.db");

assert_eq!(db.engine, "reinhardt.db.backends.sqlite3");
assert_eq!(db.name, "myapp.db");
assert!(db.user.is_none());
assert!(db.password.is_none());

pub fn postgresql( name: impl Into<String>, user: impl Into<String>, password: impl Into<String>, host: impl Into<String>, port: u16, ) -> DatabaseConfig

Available on crate feature core only.

Create a PostgreSQL database configuration

Examples

use reinhardt_conf::settings::DatabaseConfig;

let db = DatabaseConfig::postgresql("mydb", "admin", "password123", "localhost", 5432);

assert_eq!(db.engine, "reinhardt.db.backends.postgresql");
assert_eq!(db.name, "mydb");
assert_eq!(db.user, Some("admin".to_string()));
assert_eq!(db.password.as_ref().map(|p| p.expose_secret()), Some("password123"));
assert_eq!(db.host, Some("localhost".to_string()));
assert_eq!(db.port, Some(5432));

pub fn mysql( name: impl Into<String>, user: impl Into<String>, password: impl Into<String>, host: impl Into<String>, port: u16, ) -> DatabaseConfig

Available on crate feature core only.

Create a MySQL database configuration

Examples

use reinhardt_conf::settings::DatabaseConfig;

let db = DatabaseConfig::mysql("mydb", "root", "password123", "localhost", 3306);

assert_eq!(db.engine, "reinhardt.db.backends.mysql");
assert_eq!(db.name, "mydb");
assert_eq!(db.user, Some("root".to_string()));
assert_eq!(db.password.as_ref().map(|p| p.expose_secret()), Some("password123"));
assert_eq!(db.host, Some("localhost".to_string()));
assert_eq!(db.port, Some(3306));

pub fn to_url(&self) -> String

Available on crate feature core only.

Convert DatabaseConfig to DATABASE_URL string

Credentials and query parameter values are percent-encoded per RFC 3986 to prevent URL injection and parsing errors from special characters.

Examples

use reinhardt_conf::settings::DatabaseConfig;

let db = DatabaseConfig::sqlite("db.sqlite3");
assert_eq!(db.to_url(), "sqlite:db.sqlite3");

let db = DatabaseConfig::postgresql("mydb", "user", "p@ss:word", "localhost", 5432);
assert_eq!(db.to_url(), "postgresql://user:p%40ss%3Aword@localhost:5432/mydb");

Trait Implementations

impl Clone for DatabaseConfig

fn clone(&self) -> DatabaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseConfig

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

Formats the value using the given formatter.

impl Default for DatabaseConfig

fn default() -> DatabaseConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DatabaseConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<DatabaseConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DatabaseConfig

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

Formats the value using the given formatter.

impl Serialize for DatabaseConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.