Struct hoard::config::builder::Builder

pub struct Builder { /* private fields */ }

Intermediate data structure to build a Config.

Implementations

impl Builder

pub fn new() -> Self

Create a new Builder.

If build is immediately called on this, the returned Config will have all default values.

pub async fn from_file(path: &Path) -> Result<Self, Error>

Create a new Builder pre-populated with the contents of the given TOML file.

Errors

Variants of Error related to reading and parsing the file.

pub async fn from_default_file() -> Result<Self, Error>

Reads configuration from the default configuration file.

Prefers a TOML file, if found, falling back to YAML if present.

Errors

• Any errors from attempting to parse the file.
• A custom not found error if no default file is found.

pub async fn from_args_then_file() -> Result<Self, Error>

Helper method to process command-line arguments and the config file specified on CLI (or the default).

Errors

See Builder::from_file

pub fn layer(self, other: Self) -> Self

Applies all configured values in other over those in this ConfigBuilder.

pub fn set_config_dir(self, config_dir: PathBuf) -> Self

Set the config directory.

pub fn set_data_dir(self, data_dir: PathBuf) -> Self

Set the data directory.

pub fn set_hoards(self, hoards: BTreeMap<HoardName, Hoard>) -> Self

Set the hoards map.

pub fn set_environments( self, environments: BTreeMap<EnvironmentName, Environment> ) -> Self

Set the environments map for this Builder.

The map associates an environment name with the Environment definition.

pub fn set_config_file(self, path: PathBuf) -> Self

Set the file that contains configuration.

This currently only exists for completeness. You probably want Builder::from_file instead, which will actually read and parse the file.

pub fn set_command(self, cmd: Command) -> Self

Set the command that will be run.

pub fn unset_hoards(self) -> Self

Unset the hoards map

pub fn build(self) -> Result<Config, Error>

Build this Builder into a Config.

Errors

Any Error that occurs while evaluating environment or hoard definitions.

Trait Implementations

impl Args for Builder

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Builder

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Builder

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

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Builder

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Builder

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Builder

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

Serialize this value into the given Serde serializer.

impl Eq for Builder

impl StructuralEq for Builder

impl StructuralPartialEq for Builder