Struct mdbook::config::BuildConfig

pub struct BuildConfig {
    pub build_dir: PathBuf,
    pub create_missing: bool,
    pub preprocess: Option<Vec<String>>,
}

Configuration for the build procedure.

Fields

build_dir: PathBuf

Where to put built artefacts relative to the book's root directory.

create_missing: bool

Should non-existent markdown files specified in SETTINGS.md be created if they don't exist?

preprocess: Option<Vec<String>>

Which preprocessors should be applied

Trait Implementations

impl Debug for BuildConfig

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

Formats the value using the given formatter.

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for BuildConfig

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

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

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

This method tests for !=.

impl Default for BuildConfig

fn default() -> BuildConfig

Returns the "default value" for a type.