Struct BuildConfig

pub struct BuildConfig {
    pub build_dir: PathBuf,
    pub create_missing: bool,
    pub use_default_preprocessors: bool,
    pub extra_watch_dirs: Vec<PathBuf>,
}

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 SUMMARY.md be created if they don’t exist?

use_default_preprocessors: bool

Should the default preprocessors always be used when they are compatible with the renderer?

extra_watch_dirs: Vec<PathBuf>

Extra directories to trigger rebuild when watching/serving

Trait Implementations

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 Debug for BuildConfig

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

Formats the value using the given formatter.

impl Default for BuildConfig

fn default() -> BuildConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildConfig

where BuildConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BuildConfig

fn eq(&self, other: &BuildConfig) -> 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 BuildConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildConfig