Struct mdbook::config::Config

pub struct Config {
    pub book: BookConfig,
    pub build: BuildConfig,
    // some fields omitted
}

The overall configuration object for MDBook.

Fields

book: BookConfig

Metadata about the book.

build: BuildConfig

Methods

impl Config

fn from_str(src: &str) -> Result<Config>

Load a Config from some string.

fn from_disk<P: AsRef<Path>>(config_file: P) -> Result<Config>

Load the configuration file from disk.

fn get(&self, key: &str) -> Option<&Value>

Fetch an arbitrary item from the Config as a toml::Value.

You can use dotted indices to access nested items (e.g. output.html.playpen will fetch the "playpen" out of the html output table).

fn get_mut<'a>(&'a mut self, key: &str) -> Option<&'a mut Value>

Fetch a value from the Config so you can mutate it.

fn html_config(&self) -> Option<HtmlConfig>

Convenience method for getting the html renderer's configuration.

Note

This is for compatibility only. It will be removed completely once the rendering and plugin system is established.

fn get_deserialized<'de, T: Deserialize<'de>, S: AsRef<str>>(
    &self,
    name: S
) -> Result<T>

Convenience function to fetch a value from the config and deserialize it into some arbitrary type.

Trait Implementations

impl Debug for Config

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl PartialEq for Config

fn eq(&self, __arg_0: &Config) -> bool

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

fn ne(&self, __arg_0: &Config) -> bool

This method tests for !=.

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

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.