quillmark 0.58.2-rc.2

Quillmark engine API
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

//! # Orchestration
//!
//! Orchestrates the Quillmark engine and the renderable [`Quill`] type.
//!
//! ## Usage
//!
//! 1. Create an engine with [`Quillmark::new`]
//! 2. Load a quill with [`Quillmark::quill`] or [`Quillmark::quill_from_path`]
//! 3. Render documents directly via [`Quill::render`] or [`Quill::open`]

mod engine;
mod quill;

pub use engine::Quillmark;
pub use quill::Quill;

/// Ergonomic reference to a [`Quill`] object.
pub enum QuillRef<'a> {
    /// Reference to a borrowed Quill object
    Object(&'a Quill),
}

impl<'a> From<&'a Quill> for QuillRef<'a> {
    fn from(quill: &'a Quill) -> Self {
        QuillRef::Object(quill)
    }
}