Struct ManFormat 

pub struct ManFormat;

Man pages in roff: the man and mdoc macros (man).

Trait Implementations

impl Clone for ManFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ManFormat

impl Debug for ManFormat

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

Formats the value using the given formatter.

impl Default for ManFormat

fn default() -> Self

Returns the “default value” for a type.

impl DocumentFormat for ManFormat

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

.man, .roff and .mdoc are man pages; a manual section (.1 to .9, optionally with a suffix such as .3pm or .1ssl) is one when the content says so (syslog.1 is a rotated log).

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 aliases(&self) -> Vec<String>

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

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 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.

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.