Struct Page 

#[non_exhaustive]
pub struct Page {
    pub name: String,
    pub content: String,
    pub subpages: Vec<Page>,
    /* private fields */
}

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example:

You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

content: String

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

subpages: Vec<Page>

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Implementations

impl Page

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_content<T: Into<String>>(self, v: T) -> Self

Sets the value of content.

pub fn set_subpages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Page>,

Sets the value of subpages.

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Page

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

Formats the value using the given formatter.

impl Default for Page

fn default() -> Page

Returns the “default value” for a type.

impl Message for Page

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Page

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