Struct Markdown

pub struct Markdown { /* private fields */ }

Markdown it is a struct refer a true md file

including format,content and front_matter

Implementations

impl Markdown

pub fn content(&self) -> &String

pub fn front_matter(&self) -> &String

pub fn format(&self) -> &Format

impl Markdown

pub fn set_content(&mut self, val: String) -> &mut Self

pub fn set_front_matter(&mut self, val: String) -> &mut Self

pub fn set_format(&mut self, val: Format) -> &mut Self

impl Markdown

pub fn new(content: String, front_matter: String, format: Format) -> Self

pub fn write_file<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

write data into a file

Examples

use md_parser::*;
Markdown::write_file("to.md").unwrap();

pub fn bytes(&self) -> Vec<u8>

write data into Vec<u8>

pub fn display(&self) -> String

display all data as md format into a String

Examples found in repository

examples/adapt.rs (line 10)

fn main() -> Result<(), Error> {
    let origin = read_file(FILE)?;
    let md = origin.adapt::<TomlAdapter, BasicObject>()?;

    println!("{}", md.display());

    Ok(())
}

pub fn adapt<A, T>(self) -> MarkdownResult

where A: Adapter + Default, T: Serialize + DeserializeOwned,

transform a Markdown struct into another format

require two types: Data Object and Adapter

Examples

 use markdown_parser::*;
 use markdown_parser::adapt::{SafeFM, JsonAdapter};
 let origin = read_file("toml.md").unwrap();
 let md = origin.adapt::<JsonAdapter, SafeFM>().unwrap();

Examples found in repository

examples/adapt.rs (line 8)

fn main() -> Result<(), Error> {
    let origin = read_file(FILE)?;
    let md = origin.adapt::<TomlAdapter, BasicObject>()?;

    println!("{}", md.display());

    Ok(())
}

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Markdown

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

Formats the value using the given formatter.