Page

ddoc

Struct Page 

Source 
pub struct Page {
    pub title: String,
    pub page_path: PagePath,
    pub md_file_path: PathBuf,
}

Fields§

§title: String§page_path: PagePath§md_file_path: PathBuf

Implementations§

Source§

impl Page

Source

pub fn new(title: String, page_path: PagePath, md_file_path: PathBuf) -> Self

Source

pub fn write_html_head( &self, html: &mut String, project: &Project, ) -> DdResult<()>

Write the variable parts of the HTML <head>: the links to CSS, JS, meta tags, title, etc.

§Errors

Return DdError variants on write errors, not on project config/data errors

Source

pub fn write_nav_dir( &self, html: &mut String, tag: &str, nav_dir: &NavDir, project: &Project, ) -> DdResult<()>

Write the HTML content for a navigation directory (header or footer)

Source

pub fn write_html_article( &self, html: &mut String, md: &str, project: &Project, ) -> DdResult<()>

Write the part of the HTML generated from the page’s Markdown content

The resulting html contains,

  • at top level: an <article> element, which contains:
    • <nav class=page-toc> : the table of contents for the page
    • <main> : the main content of the page
Source

pub fn write_html(&self, html: &mut String, project: &Project) -> DdResult<()>

Write the full HTML for this page into the given html String

§Errors

Return DdError variants on write errors, not on project config/data errors

Auto Trait Implementations§

§

impl Freeze for Page

§

impl RefUnwindSafe for Page

§

impl Send for Page

§

impl Sync for Page

§

impl Unpin for Page

§

impl UnwindSafe for Page

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V