Skip to main content

Forge

Struct Forge 

Source
pub struct Forge { /* private fields */ }
Expand description

Compiled mdforge schema and processing pipeline.

Implementations§

Source§

impl Forge

Source

pub fn builder() -> ForgeBuilder

Start building a Forge schema.

Source

pub fn parse(&self, input: &str) -> Result<Document, Vec<Diagnostic>>

Parse source text into a Document.

Source

pub fn validate(&self, doc: &Document) -> Result<(), Vec<Diagnostic>>

Validate parsed blocks, inlines, required arguments, and static types.

Source

pub fn eval( &self, doc: &Document, dynamic_ctx: &EvalContext, ) -> Result<EvalContext, Vec<Diagnostic>>

Evaluate runtime-dependent constraints such as dynamic enums.

Source

pub fn render_dom( &self, doc: &Document, ctx: &EvalContext, renderer: &dyn DomRenderer, ) -> Result<Vec<VNode>, Vec<Diagnostic>>

Render a document into a virtual DOM using a custom renderer.

Source

pub fn signature(&self) -> String

Generate a compact syntax signature for prompts or documentation.

Source

pub fn render_html( &self, doc: &Document, ctx: &EvalContext, renderer: &dyn HtmlRenderer, ) -> Result<String, Vec<Diagnostic>>

Render a document to HTML using pulldown-cmark for normal Markdown.

Trait Implementations§

Source§

impl Clone for Forge

Source§

fn clone(&self) -> Forge

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Forge

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Forge

Source§

fn eq(&self, other: &Forge) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Forge

Source§

impl StructuralPartialEq for Forge

Auto Trait Implementations§

§

impl Freeze for Forge

§

impl RefUnwindSafe for Forge

§

impl Send for Forge

§

impl Sync for Forge

§

impl Unpin for Forge

§

impl UnsafeUnpin for Forge

§

impl UnwindSafe for Forge

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.