Struct migrant_lib::config::SettingsFileInitializer

pub struct SettingsFileInitializer { /* fields omitted */ }

Project settings file builder to initialize a new settings file

Implementations

impl SettingsFileInitializer

pub fn interactive(&mut self, b: bool) -> &mut Self

Set interactive prompts, default is true

pub fn with_env_defaults(&mut self, b: bool) -> &mut Self

Default all file values env:<ENV_VAR> if unspecified

pub fn with_sqlite_options(
    &mut self,
    options: &SqliteSettingsBuilder
) -> &mut Self

Specify Sqlite database options

Example:

use migrant_lib::Config;
use migrant_lib::config::SqliteSettingsBuilder;
Config::init_in(env::current_dir()?)
    .with_sqlite_options(
        SqliteSettingsBuilder::empty()
            .database_path("/abs/path/to/my.db")?)
    .initialize()?;

pub fn with_postgres_options(
    &mut self,
    options: &PostgresSettingsBuilder
) -> &mut Self

Specify Postgres database options

Example:

use migrant_lib::Config;
use migrant_lib::config::PostgresSettingsBuilder;
Config::init_in(env::current_dir()?)
    .with_postgres_options(
        PostgresSettingsBuilder::empty()
            .database_name("my_db")
            .database_user("me")
            .database_port(4444))
    .initialize()?;

pub fn with_mysql_options(
    &mut self,
    options: &MySqlSettingsBuilder
) -> &mut Self

Specify MySQL database options

Example:

use migrant_lib::Config;
use migrant_lib::config::MySqlSettingsBuilder;
Config::init_in(env::current_dir()?)
    .with_mysql_options(
        MySqlSettingsBuilder::empty()
            .database_name("my_db")
            .database_user("me")
            .database_port(4444))
    .initialize()?;

pub fn initialize(&self) -> Result<()>

Generate a template config file using provided parameters or prompting the user. If running interactively, the file will be opened for editing and Config::setup will be run automatically.

Trait Implementations

impl Clone for SettingsFileInitializer

fn clone(&self) -> SettingsFileInitializer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsFileInitializer

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

Formats the value using the given formatter.