Enum OutputFormat

pub enum OutputFormat {
    Pdf {
        engine: PdfEngine,
        theme: Option<Theme>,
    },
    Docx {
        theme: Option<Theme>,
    },
    Odt {
        theme: Option<Theme>,
    },
    Markdown {
        theme: Option<Theme>,
    },
    Commonmark {
        theme: Option<Theme>,
    },
    CommonmarkX {
        theme: Option<Theme>,
    },
}

Enum type for defining the possible output file formats

Variants

Pdf

The PDF file format

Fields

engine: PdfEngine

Specifies the program that is used to render the PDF document

theme: Option<Theme>

The theme which should be used for the rendered document

Docx

Microsoft Office Open XML docx format

Fields

theme: Option<Theme>

The theme which should be used for the rendered document

Odt

OpenDocument Text format

Fields

theme: Option<Theme>

The theme which should be used for the rendered document

Markdown

Markdown

Fields

theme: Option<Theme>

The theme which should be used for the rendered document

Commonmark

CommonMark flavored Markdown

Fields

theme: Option<Theme>

The theme which should be used for the rendered document

CommonmarkX

CommonMark flavored Markdown with pandoc extensions

Fields

theme: Option<Theme>

The theme which should be used for the rendered document

Implementations

impl OutputFormat

pub fn default_pdf() -> Self

Create the PDF output format with the default configuration.

impl OutputFormat

pub fn theme(&self) -> Option<&str>

The color theme of the output document.

Trait Implementations

impl AsRef<str> for OutputFormat

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl Default for OutputFormat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OutputFormat

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

Formats the value using the given formatter.

impl EnumCount for OutputFormat

const COUNT: usize = 6usize

impl<'_derivative_strum> From<&'_derivative_strum OutputFormat> for &'static str

fn from(x: &'_derivative_strum OutputFormat) -> &'static str

Converts to this type from the input type.

impl From<OutputFormat> for &'static str

fn from(x: OutputFormat) -> &'static str

Converts to this type from the input type.

impl FromStr for OutputFormat

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<OutputFormat, <Self as FromStr>::Err>

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

impl IntoEnumIterator for OutputFormat

type Iterator = OutputFormatIter

fn iter() -> OutputFormatIter

impl PartialEq for OutputFormat

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for OutputFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for OutputFormat

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<OutputFormat, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantNames for OutputFormat

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Eq for OutputFormat

impl StructuralPartialEq for OutputFormat