Struct distant::config::Config

pub struct Config {
    pub client: ClientConfig,
    pub generate: GenerateConfig,
    pub manager: ManagerConfig,
    pub server: ServerConfig,
}

Represents configuration settings for all of distant

Fields

client: ClientConfig

generate: GenerateConfig

manager: ManagerConfig

server: ServerConfig

Implementations

impl Config

pub fn load_multi(custom: Option<PathBuf>) -> Result<Self>

Loads the configuration from multiple sources in a blocking fashion

1. If custom is provided, it is used by itself as the source for configuration
2. Otherwise, if custom is not provided, will attempt to load from global and user config files, merging together if they both exist
3. Otherwise if no custom path and none of the standard configuration paths exist, then the default configuration is returned instead

pub async fn load(path: impl AsRef<Path>) -> Result<Self>

Loads the specified path as a Config

pub async fn edit_if_exists(
    path: impl AsRef<Path>,
    f: impl FnOnce(&mut Document) -> Result<()>
) -> Result<()>

Like edit but will succeed without invoking f if the path is not found

pub async fn edit(
    path: impl AsRef<Path>,
    f: impl FnOnce(&mut Document) -> Result<()>
) -> Result<()>

Loads the specified path as a Document, performs changes to the document using f, and overwrites the path with the updated Document

pub async fn save_if_not_found(&self, path: impl AsRef<Path>) -> Result<()>

Saves the Config to the specified path only if the path points to no file

pub async fn save(&self, path: impl AsRef<Path>) -> Result<()>

Saves the Config to the specified path, overwriting the file if it exists

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

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 Serialize for Config

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

Serialize this value into the given Serde serializer.