Struct Config 

pub struct Config {
    pub client_name: String,
    pub build_info: Option<String>,
    pub writeable_path: String,
    pub background_work: bool,
    pub logs: bool,
    pub stdout_logs: bool,
    pub colored_logs: bool,
    pub client_type: ClientType,
}

Fields

client_name: String

Identifies the client in startup logs and lockbook-<client_name>.log.

build_info: Option<String>

Optional build identity of a client compiled separately from Rust.

writeable_path: String

Where should lockbook store data, including logs?

background_work: bool

Should lb do background work like keep search indexes up to date?

logs: bool

Should we log at all?

stdout_logs: bool

Should logs be printed to stdout?

colored_logs: bool

Should logs be colored?

client_type: ClientType

Implementations

impl Config

pub fn cli_config(writeable_path_subfolder: &str) -> Config

Configures lockbook for CLI use with no stdout logs or background work. writeable_path_subfolder is generally a hardcoded client name like "cli".

pub fn ui_config(writeable_path_subfolder: &str) -> Config

Configures lockbook for UI use with stdout logs and background work. writeable_path_subfolder is generally a hardcoded client name like "macos".

pub fn writeable_path(writeable_path_subfolder: &str) -> String

Produces a full writable path for lockbook to use based on environment variables and platform. Useful for initializing the Config struct.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Config> for AsyncDocs

fn from(cfg: &Config) -> Self

Converts to this type from the input type.