Enum Renderer

pub enum Renderer {
    Passthrough,
    Markdown,
    GFM,
}

Renderer.

Variants

Passthrough

Passthrough.

Markdown

Markdown.

GFM

GitHub-Flavored Markdown.

Implementations

impl Renderer

pub async fn render(&self, content: &str) -> Result<ByteString, StatusCode>

Render.

pub fn title_from_content( &self, content: &str, ) -> Result<Option<ByteString>, StatusCode>

Title from content.

pub fn render_markdown( content: &str, options: Options, ) -> Result<ByteString, StatusCode>

Render Markdown.

pub fn title_from_passthrough<'content>( &self, content: &'content str, ) -> Result<Option<&'content str>, StatusCode>

Title from passthrough content.

This will be the first <h1>.

pub fn title_from_markdown( &self, content: &str, options: &ParseOptions, ) -> Result<Option<ByteString>, StatusCode>

Title from Markdown content.

This will be the text in the first heading.

Trait Implementations

impl Clone for Renderer

fn clone(&self) -> Renderer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Renderer

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

Formats the value using the given formatter.

impl Default for Renderer

fn default() -> Renderer

Returns the “default value” for a type.

impl Display for Renderer

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

Formats the value using the given formatter.

impl FromStr for Renderer

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(representation: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Into<&'static str> for Renderer

fn into(self) -> &'static str

Converts this type into the (usually inferred) input type.

impl RenderPreparer for Renderer

async fn prepare<'own>( &self, context: &mut RenderContext<'own>, ) -> Result<(), StatusCode>

Prepare.

impl<ContextT, ErrorT> Resolve<Renderer, ContextT, ErrorT> for Value

where ContextT: ResolveContext, ErrorT: ResolveError,

fn resolve_for<ErrorRecipientT>( &self, context: Option<&ContextT>, ancestor: Option<&Value>, errors: &mut ErrorRecipientT, ) -> ResolveResult<Renderer, ErrorT>

where ErrorRecipientT: ErrorRecipient<ErrorT>,

Resolve one type into another.

fn resolve_into<ErrorRecipientT>( &self, errors: &mut ErrorRecipientT, ) -> Result<Option<ResolvedT>, ErrorT>

where ErrorRecipientT: ErrorRecipient<ErrorT>,

Resolve one type into another with a provided ErrorRecipient.

fn resolve(&self) -> Result<Option<ResolvedT>, ErrorT>

Resolve one type into another while failing on the first encountered error.

impl Copy for Renderer