Struct mdbook::config::Config
[−]
[src]
pub struct Config { pub book: BookConfig, pub build: BuildConfig, // 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.
Methods
impl Config
[src]
fn from_str(src: &str) -> Result<Config>
[src]
Load a Config
from some string.
fn from_disk<P: AsRef<Path>>(config_file: P) -> Result<Config>
[src]
Load the configuration file from disk.
fn update_from_env(&mut self)
[src]
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.
fn get(&self, key: &str) -> Option<&Value>
[src]
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>
[src]
Fetch a value from the Config
so you can mutate it.
fn get_deserialized<'de, T: Deserialize<'de>, S: AsRef<str>>(
&self,
name: S
) -> Result<T>
[src]
&self,
name: S
) -> Result<T>
Convenience function to fetch a value from the config and deserialize it into some arbitrary type.
fn set<S: Serialize, I: AsRef<str>>(&mut self, index: I, value: S) -> Result<()>
[src]
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
.
Trait Implementations
impl Debug for Config
[src]
impl Clone for Config
[src]
fn clone(&self) -> Config
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for Config
[src]
fn eq(&self, __arg_0: &Config) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Config) -> bool
[src]
This method tests for !=
.
impl Default for Config
[src]
impl<'de> Deserialize<'de> for Config
[src]
fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>
[src]
Deserialize this value from the given Serde deserializer. Read more