Struct snekdown::elements::Document

pub struct Document {
    pub elements: Vec<Block>,
    pub config: Arc<Mutex<Settings>>,
    pub bibliography: BibManager,
    pub downloads: Arc<Mutex<DownloadManager>>,
    pub images: Arc<Mutex<ImageConverter>>,
    pub stylesheets: Vec<Arc<Mutex<PendingDownload>>>,
    pub glossary: Arc<Mutex<GlossaryManager>>,
    // some fields omitted
}

Fields

elements: Vec<Block>

config: Arc<Mutex<Settings>>

bibliography: BibManager

downloads: Arc<Mutex<DownloadManager>>

images: Arc<Mutex<ImageConverter>>

stylesheets: Vec<Arc<Mutex<PendingDownload>>>

glossary: Arc<Mutex<GlossaryManager>>

Implementations

impl Document

pub fn new() -> Self

Creates a new parent document

pub fn create_child(&self) -> Self

Creates a new child document

pub fn add_element(&mut self, element: Block)

pub fn add_placeholder(&mut self, placeholder: Arc<RwLock<Placeholder>>)

pub fn create_toc(&self, ordered: bool) -> List

pub fn postprocess_imports(&mut self)

Processes section and import elements

if it encounters a section it checks if the sections is of smaller order than the previous one if thats the case it grabs the previous one and adds the section to its children

if it encounters an import, it loads the imports top elements to its own

pub fn post_process(&mut self)

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl ToHtml for Document

fn to_html(&self, writer: &mut HTMLWriter) -> Result<()>