ConfigBuilder

Struct ConfigBuilder 

Source
pub struct ConfigBuilder {
    pub session_id: Option<String>,
    pub puzzle_dir: Option<PathBuf>,
    pub sessions_dir: Option<PathBuf>,
    pub passphrase: Option<String>,
    pub fake_time: Option<DateTime<Utc>>,
}
Expand description

A builder interface for specifying configuration settings to the Advent of Client client. Configuration settings have sensible default values, and should only be changed when the user wants custom behavior.

§Default Values

  • session_id: The user’s Advent of Code session cookie. This is required for getting input and submitting answers.
  • passphrase: The hostname of the current machine. A custom passphrase is required if puzzle_dir is changed.
  • puzzle_dir: A directory in the local user’s cache dir (e.g., XDG_CACHE_HOME on Linux).
  • sessions_dir: A directory in the local user’s cache dir (e.g., XDG_CACHE_HOME on Linux).

Fields§

§session_id: Option<String>§puzzle_dir: Option<PathBuf>§sessions_dir: Option<PathBuf>§passphrase: Option<String>§fake_time: Option<DateTime<Utc>>

Implementations§

Source§

impl ConfigBuilder

Source

pub fn new() -> Self

Create a new ConfigBuilder object with all fields initialized to None.`

Source

pub fn use_toml(self, config_text: &str) -> Result<Self, ConfigError>

Loads configuration values from string containing TOML formatted text. Configuration values loaded here will overwrite previously loaded values.

Source

pub fn with_session_id<S: Into<String>>(self, session_id: S) -> Self

Source

pub fn with_puzzle_dir<P: Into<PathBuf>>(self, puzzle_dir: P) -> Self

Source

pub fn with_sessions_dir<P: Into<PathBuf>>(self, sessions_dir: P) -> Self

Source

pub fn with_passphrase<S: Into<String>>(self, passphrase: S) -> Self

Source

pub fn with_fake_time(self, fake_time: DateTime<Utc>) -> Self

Source

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

Generate a Config object from the settings in this ConfigBuilder object.

Trait Implementations§

Source§

impl Default for ConfigBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,