Struct mdbook::config::Config

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

The overall configuration object for MDBook, essentially an in-memory representation of book.toml.

Fields

book: BookConfig

Metadata about the book.

build: BuildConfig

Information about the build environment.

rust: RustConfig

Information about Rust language support.

Implementations

impl Config

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

Load the configuration file from disk.

pub fn update_from_env(&mut self)

Updates the Config from the available environment variables.

Variables starting with MDBOOK_ are used for configuration. The key is created by removing the MDBOOK_ prefix and turning the resulting string into kebab-case. Double underscores (__) separate nested keys, while a single underscore (_) is replaced with a dash (-).

For example:

• MDBOOK_foo -> foo
• MDBOOK_FOO -> foo
• MDBOOK_FOO__BAR -> foo.bar
• MDBOOK_FOO_BAR -> foo-bar
• MDBOOK_FOO_bar__baz -> foo-bar.baz

So by setting the MDBOOK_BOOK__TITLE environment variable you can override the book’s title without needing to touch your book.toml.

Note: To facilitate setting more complex config items, the value of an environment variable is first parsed as JSON, falling back to a string if the parse fails.

This means, if you so desired, you could override all book metadata when building the book with something like

$ export MDBOOK_BOOK='{"title": "My Awesome Book", "authors": ["Michael-F-Bryan"]}'
$ mdbook build

The latter case may be useful in situations where mdbook is invoked from a script or CI, where it sometimes isn’t possible to update the book.toml before building.

pub 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.playground will fetch the “playground” out of the html output table).

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

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

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

👎 Deprecated:

use get_deserialized_opt instead

Deprecated, use get_deserialized_opt instead.

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

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

pub fn set<S: Serialize, I: AsRef<str>>(
    &mut self,
    index: I,
    value: S
) -> Result<()>

Set a config key, clobbering any existing values along the way.

The only way this can fail is if we can’t serialize value into a toml::Value.

pub fn get_renderer<I: AsRef<str>>(&self, index: I) -> Option<&Table>

Get the table associated with a particular renderer.

pub fn get_preprocessor<I: AsRef<str>>(&self, index: I) -> Option<&Table>

Get the table associated with a particular preprocessor.

Trait Implementations

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 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<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl FromStr for Config

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

Load a Config from some string.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq<Config> for Config

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

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

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

This method tests for !=.

impl Serialize for Config

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config