Struct SourceRendererFormat 

pub struct SourceRendererFormat { /* private fields */ }

A plugin’s SourceRenderer as a document format: the renderer draws the source; the id, name, extensions and an optional sniffer come from the host that wraps it.

Implementations

impl SourceRendererFormat

pub fn new(id: impl Into<String>, renderer: Arc<dyn SourceRenderer>) -> Self

Wrap renderer as the format id.

pub fn name(self, name: impl Into<String>) -> Self

The name people call the format.

pub fn extensions(self, extensions: &[&str]) -> Self

The extensions it claims, without the dot.

pub fn sniffer( self, sniffer: impl Fn(&str) -> f32 + Send + Sync + 'static, ) -> Self

A content sniffer (0 to 1).

Trait Implementations

impl DocumentFormat for SourceRendererFormat

fn id(&self) -> &str

The format’s id: lowercase, stable, usable as a CLI value ("org").

fn name(&self) -> &str

The name people call it ("Org").

fn extensions(&self) -> Vec<String>

The file extensions it claims, lowercase, without the dot.

fn sniff(&self, text: &str) -> f32

How confident it is that text is in this format, from 0 to 1. See LIKELY and CERTAIN.

fn render(&self, source: &str, _options: &RenderOptions) -> Rendered

Render source. The default draws parse’s document with DocumentView, or the source as plain text when the format does not parse into the model.

fn aliases(&self) -> Vec<String>

Other ids accepted for it ("adoc" for AsciiDoc).

fn match_name(&self, file_name: &str) -> NameMatch

How file_name (a base name) relates to this format. By default a name whose extension is one of extensions is NameMatch::Yes.

fn features(&self) -> Vec<String>

What the format supports ("tables", "admonitions", …), for listings and for callers that want to know before rendering.

fn parse(&self, _source: &str) -> Option<Parsed>

Parse source into the shared model, for formats built on it.