Struct Config 

#[non_exhaustive]
pub struct Config {
    pub book: BookConfig,
    pub build: BuildConfig,
    pub rust: RustConfig,
    /* private fields */
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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>(config_file: P) -> Result<Config, Error>

where P: AsRef<Path>,

Load the configuration file from disk.

pub fn update_from_env(&mut self) -> Result<(), Error>

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_book -> book
• MDBOOK_BOOK -> book
• MDBOOK_BOOK__TITLE -> book.title
• MDBOOK_BOOK__TEXT_DIRECTION -> book.text-direction

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<'de, T>(&self, name: &str) -> Result<Option<T>, Error>

where T: Deserialize<'de>,

Get a value from the configuration.

This fetches a value from the book configuration. The key can have dotted indices to access nested items (e.g. output.html.playground will fetch the “playground” out of the html output table).

This can only access the output and preprocessor tables.

Returns Ok(None) if the field is not set.

Returns Err if it fails to deserialize.

pub fn contains_key(&self, name: &str) -> bool

Returns whether the config contains the given dotted key name.

The key can have dotted indices to access nested items (e.g. preprocessor.foo.bar will check if that key is set in the config).

This can only access the output and preprocessor tables.

pub fn preprocessors<'de, T>(&self) -> Result<BTreeMap<String, T>, Error>

where T: Deserialize<'de>,

Returns the configuration for all preprocessors.

pub fn outputs<'de, T>(&self) -> Result<BTreeMap<String, T>, Error>

where T: Deserialize<'de>,

Returns the configuration for all renderers.

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

where S: Serialize, I: AsRef<str>,

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

The key can have dotted indices for nested items (e.g. output.html.playground will set the “playground” in the html output table).

Errors

This will fail if:

• The value cannot be represented as TOML.
• The value is not a correct type.
• The key is an unknown configuration option.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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<(), Error>

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

where Config: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Config, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Config

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

Load a Config from some string.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config