Struct mdbook::config::BookConfig

pub struct BookConfig {
    pub title: Option<String>,
    pub authors: Vec<String>,
    pub description: Option<String>,
    pub src: PathBuf,
    pub multilingual: bool,
    pub language: Option<String>,
    pub text_direction: Option<TextDirection>,
}

Configuration options which are specific to the book and required for loading it from disk.

Fields

title: Option<String>

The book’s title.

authors: Vec<String>

The book’s authors.

description: Option<String>

An optional description for the book.

src: PathBuf

Location of the book source relative to the book’s root directory.

multilingual: bool

Does this book support more than one language?

language: Option<String>

The main language of the book.

text_direction: Option<TextDirection>

The direction of text in the book: Left-to-right (LTR) or Right-to-left (RTL). When not specified, the text direction is derived from BookConfig::language.

Implementations

impl BookConfig

pub fn realized_text_direction(&self) -> TextDirection

Gets the realized text direction, either from BookConfig::text_direction or derived from BookConfig::language, to be used by templating engines.

Trait Implementations

impl Clone for BookConfig

fn clone(&self) -> BookConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BookConfig

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

Formats the value using the given formatter.

impl Default for BookConfig

fn default() -> BookConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BookConfig

where BookConfig: 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 BookConfig

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

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

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

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

impl Serialize for BookConfig

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 BookConfig