Struct mdpage::Content

pub struct Content {
    pub is_heading: Option<bool>,
    pub is_break: Option<bool>,
    pub label: Option<String>,
    pub url: Option<String>,
    pub markdown: Option<String>,
    pub html: Option<String>,
    pub file: Option<PathBuf>,
    pub dir: Option<PathBuf>,
}

Content struct represents content of the document as well as the menu items.

Fields

is_heading: Option<bool>

A boolean flag to specify that the object is a heading in the menu. In this case it must have "label" specified to be displayed in the menu.

is_break: Option<bool>

A boolean flag to specify a line break in the menu.

label: Option<String>

The string to be used as label for the content in the menu.

url: Option<String>

The URL for an external link. If specified the menu will be a link to this URL.

markdown: Option<String>

The optional raw markdown to be converted into HTML for the content. Usually this would be read from a file.

html: Option<String>

The raw markdown to be converted into HTML for the content. This is normally generated by converting the markdown contents.

file: Option<PathBuf>

The path to the markdown or HTML file used for the content. We read this into markdown property and convert it to HTML content to be displayed. If label is not specified, we also infer the title for the content from the heading in markdown content.

dir: Option<PathBuf>

As an alternative to file we can specify the directory path used to build contents. The content will be sourced from all the files and immediate subdirectories in the path.

Methods

impl Content

pub fn new(file: Option<PathBuf>) -> Content

pub fn new_heading(label: String) -> Content

pub fn new_break() -> Content

pub fn init_from_file(&mut self, root: &Path)

Initializes the label from the file property if present.

Trait Implementations

impl Clone for Content

fn clone(&self) -> Content

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Content

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

Formats the value using the given formatter.

impl Default for Content

fn default() -> Content

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Content

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Content> for Content

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Content

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

Serialize this value into the given Serde serializer.