Struct ConfigurationBuilder

pub struct ConfigurationBuilder { /* private fields */ }

A builder for creating a Configuration instance.

Implementations

impl ConfigurationBuilder

pub fn new<S: Into<String>>(program_name: S, version: S) -> Self

pub fn with_config(self) -> Self

Initialize configuration from the configuration file. The configuration file is located in the user’s home directory in a hidden directory named after the program name (e.g. .rsql) or in the current working directory if the home directory is not available. The configuration file is named after the program name with a .toml extension (e.g. .rsql.toml).

If the configuration file does not exist, it is created with the default configuration.

pub fn with_config_dir<P: Into<PathBuf>>(self, config_dir: P) -> Self

Initialize configuration from the configuration file. The configuration file is located in the user’s home directory in a hidden directory named after the program name (e.g. .rsql) or in the current working directory if the home directory is not available. The configuration file is named after the program name with a .toml extension (e.g. .rsql.toml).

If the configuration file does not exist, it is created with the default configuration.

Panics

Panics if the configuration file cannot be loaded.

pub fn with_bail_on_error(self, bail_on_error: bool) -> Self

Set the bail on error to use.

pub fn with_color(self, color: bool) -> Self

Set the color value.

pub fn with_command_identifier<S: Into<String>>( self, command_identifier: S, ) -> Self

Set the command identifier value.

pub fn with_echo(self, echo: EchoMode) -> Self

Set the echo value.

pub fn with_log_level(self, log_level: LevelFilter) -> Self

Set the log level to use.

pub fn with_log_dir<P: Into<PathBuf>>(self, log_dir: P) -> Self

Set the log directory to use.

pub fn with_log_rotation(self, log_rotation: Rotation) -> Self

Set the log rotation to use.

pub fn with_locale<S: Into<String>>(self, locale: S) -> Self

Set the locale to use.

pub fn with_edit_mode(self, edit_mode: EditMode) -> Self

Set the edit mode to use.

pub fn with_history(self, history: bool) -> Self

Set the history to use.

pub fn with_history_file<P: Into<PathBuf>>(self, history_file: P) -> Self

Set the history file to use.

pub fn with_history_limit(self, history_limit: usize) -> Self

Set the history limit to use.

pub fn with_history_ignore_dups(self, history_ignore_dups: bool) -> Self

Set the history ignore dups to use.

pub fn with_theme<S: Into<String>>(self, theme: S) -> Self

Set the theme to use.

pub fn with_results_changes(self, results_changes: bool) -> Self

Set the display of rows changed.

pub fn with_results_footer(self, results_footer: bool) -> Self

Set the display of the results’ footer.

pub fn with_results_format<S: Into<String>>(self, results_format: S) -> Self

Set the results format to use.

pub fn with_results_header(self, results_header: bool) -> Self

Set the display of the results’ header.

pub fn with_results_limit(self, results_limit: usize) -> Self

Set the limit for the number of results returned.

pub fn with_results_rows(self, results_rows: bool) -> Self

Set the display of rows returned.

pub fn with_results_timer(self, results_timer: bool) -> Self

Set the display of the results’ timer.

pub fn with_smart_completions(self, smart_completions: bool) -> Self

pub fn build(self) -> Configuration

Build a Configuration instance.

Panics

Panics if the log file appender cannot be created.

Trait Implementations

impl Clone for ConfigurationBuilder

fn clone(&self) -> ConfigurationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for ConfigurationBuilder

fn default() -> ConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for ConfigurationBuilder

fn eq(&self, other: &ConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConfigurationBuilder

impl StructuralPartialEq for ConfigurationBuilder