Enum tpnote_lib::markup_language::MarkupLanguage

pub enum MarkupLanguage {
    Markdown,
    Restructuredtext,
    Html,
    PlainText,
    PlainTextNoViewer,
    Unkown,
    None,
}

The Markup language of the note content.

Variants

Markdown

Restructuredtext

Html

PlainText

PlainTextNoViewer

The exporter renders this, but the viewer is disabled.

Unkown

This is a Tp-Note file, but we are not able to determine the MarkupLanguage at this point.

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.

pub fn mine_type(&self) -> Option<&'static str>

Returns the MIME type for all Markup Languages.is_tpnote_file()==true. Otherwise, for MarkupLanguage::None this returns None.

pub fn is_some(&self) -> bool

As we identify a markup language by the file’s extension, we can also tell, in case Markuplanguage::from(ext).is_some(), that a file with the extension ext is a Tp-Note file.

pub fn is_none(&self) -> bool

As we identify a markup language by the file’s extension, we can also tell, in case Markuplanguage::from(ext).is_none(), that a file with the extension ext is NOT a Tp-Note file.

pub fn render(&self, input: &str) -> String

Every MarkupLanguage variant has an own internal HTML renderer:

• Markdown is rendered according the “CommonMark” standard.
• Currently only as small subset of ReStructuredText is rendered for Restructuredtext. This feature is experimental.
• The Html renderer simply forwards the input without modification.
• PlainText is rendered as raw text. Hyperlinks in Markdown, ReStructuredText, AsciiDoc and WikiText syntax are detected and are displayed in the rendition with their link text. All hyperlinks are clickable.
• Unknown is rendered like PlainText, hyperlinks are also clickable, but they are displayed as they appear in the input.
• For the variant None the result is always the empty string whatever the input may be.

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 Default for MarkupLanguage

fn default() -> MarkupLanguage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkupLanguage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Path> for MarkupLanguage

fn from(path: &Path) -> Self

Is the file extension at the end of the given path listed infile.extensions`?

impl From<&str> for MarkupLanguage

fn from(file_extension: &str) -> Self

Is file_extension listed in file.extensions?

impl Hash for MarkupLanguage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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 Serialize for MarkupLanguage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MarkupLanguage

impl Eq for MarkupLanguage

impl StructuralEq for MarkupLanguage

impl StructuralPartialEq for MarkupLanguage