Enum tpnote_lib::markup_language::MarkupLanguage

pub enum MarkupLanguage {
    Markdown,
    RestructuredText,
    Html,
    Txt,
    Unknown,
    None,
}

The Markup language of the note content.

Variants

Markdown

RestructuredText

Html

Txt

Unknown

We can not determine the markup language, but confirm that this is a Tp-Note file.

None

This is not a Tp-Note file.

Implementations

impl MarkupLanguage

pub fn or(self, rhs: Self) -> Self

If Self is None return rhs, otherwise return Self.

Examples found in repository

src/note.rs (line 487)

    pub fn render_content_to_html(
        &self,
        // We need the file extension to determine the
        // markup language.
        file_ext: &str,
        // HTML template for this rendition.
        tmpl: &str,
    ) -> Result<String, NoteError> {
        // Deserialize.

        // Render Body.
        let input = self.content.body();

        // If this variable is set, overwrite `file_ext`
        let fm_file_ext = match self.context.get(TMPL_VAR_FM_FILE_EXT) {
            Some(tera::Value::String(fm_file_ext)) => fm_file_ext.as_str(),
            _ => "",
        };

        // Render the markup language.
        let html_output = match MarkupLanguage::from(fm_file_ext).or(MarkupLanguage::from(file_ext))
        {
            #[cfg(feature = "renderer")]
            MarkupLanguage::Markdown => Self::render_md_content(input),
            #[cfg(feature = "renderer")]
            MarkupLanguage::RestructuredText => Self::render_rst_content(input)?,
            MarkupLanguage::Html => input.to_string(),
            _ => Self::render_txt_content(input),
        };

        let mut html_context = self.context.clone();

        // Register rendered body.
        html_context.insert(TMPL_HTML_VAR_NOTE_BODY_HTML, &html_output);

        // Insert the raw CSS
        html_context.insert(
            TMPL_HTML_VAR_NOTE_CSS,
            &LIB_CFG.read().unwrap().tmpl_html.css,
        );
        // Insert the web server path to get the CSS loaded.
        html_context.insert(
            TMPL_HTML_VAR_NOTE_CSS_PATH,
            TMPL_HTML_VAR_NOTE_CSS_PATH_VALUE,
        );

        let mut tera = Tera::default();
        tera.extend(&TERA)?;
        let html = tera.render_str(tmpl, &html_context).map_err(|e| {
            note_error_tera_template!(e, "[html_tmpl] viewer/exporter_tmpl ".to_string())
        })?;

        Ok(html)
    }

Trait Implementations

impl Clone for MarkupLanguage

fn clone(&self) -> MarkupLanguage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkupLanguage

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

Formats the value using the given formatter.

impl From<&Path> for MarkupLanguage

fn from(file_extension: &Path) -> Self

Is file_extension listed in one of the known file extension lists?

impl From<&str> for MarkupLanguage

fn from(file_extension: &str) -> Self

Is file_extension listed in one of the known file extension lists?

impl PartialEq<MarkupLanguage> for MarkupLanguage

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

impl StructuralEq for MarkupLanguage

impl StructuralPartialEq for MarkupLanguage