Enum MetadataOutput 

pub enum MetadataOutput {
    None,
    Json,
    Frontmatter,
}

Where the metadata goes in the exports. None (the default) keeps it to the in-memory document; Json adds a metadata object to the docling JSON (after origin); Frontmatter opens the Markdown with a YAML front matter block as well.

Variants

None

Json

Frontmatter

Implementations

impl MetadataOutput

pub const ACCEPTED: &'static str = "none, json, frontmatter"

The option’s accepted spellings, for error messages.

pub fn parse(s: &str) -> Option<Self>

Parse the wire spelling (case-insensitive; front_matter and front-matter read as frontmatter).

pub fn as_str(self) -> &'static str

pub fn in_json(self) -> bool

Whether the JSON export carries the metadata object.

pub fn front_matter(self) -> bool

Whether the Markdown export opens with the front matter.

Trait Implementations

impl Clone for MetadataOutput

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 MetadataOutput

impl Debug for MetadataOutput

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

Formats the value using the given formatter.

impl Default for MetadataOutput

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MetadataOutput

impl PartialEq for MetadataOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MetadataOutput