Struct MarkdownRenderer

pub struct MarkdownRenderer { /* private fields */ }

Implementations

impl MarkdownRenderer

pub const fn new(indent_spaces: usize, depth_increment: usize) -> Self

Creates a new MarkdownRenderer.

Arguments

• indent_spaces - Number of spaces to use for indentation.
• depth_increment - Increment to apply for nested structures.

Examples

let renderer = MarkdownRenderer::new(1, 2);

pub fn render(&self, json: &Value) -> String

Renders a JSON value into a Markdown string.

Arguments

• json - The JSON value to render.

Errors

Examples

let renderer = MarkdownRenderer::new(1, 2);
let json = serde_json::json!({"title": "My Document"});
let markdown = renderer.render(&json);

Examples found in repository

examples/convert.rs (line 10)

fn main() {
    let json = include_str!("./input.json");
    let json = serde_json::from_str(json).unwrap_or_else(|e| {
        panic!("couldn't convert the input into serde_json::Value, error: {e}")
    });

    let renderer = MarkdownRenderer::default();
    let markdown = renderer.render(&json);

    println!("{markdown}");
}

Trait Implementations

impl Clone for MarkdownRenderer

fn clone(&self) -> MarkdownRenderer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownRenderer

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

Formats the value using the given formatter.

impl Default for MarkdownRenderer

fn default() -> Self

Returns the “default value” for a type.

impl Copy for MarkdownRenderer