ox_content_renderer 2.3.0

Markdown renderer for Ox Content
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! Renderer trait and utilities.

use ox_content_ast::Document;
use thiserror::Error;

/// Result type for rendering operations.
pub type RenderResult<T> = Result<T, RenderError>;

/// Render error.
#[derive(Debug, Error)]
pub enum RenderError {
    /// IO error during rendering.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// Custom error.
    #[error("{0}")]
    Custom(String),
}

/// Trait for rendering Markdown AST to various output formats.
pub trait Renderer {
    /// The output type of the renderer.
    type Output;

    /// Renders a document to the output format.
    fn render(&mut self, document: &Document<'_>) -> RenderResult<Self::Output>;
}