Skip to main content

Module metadata

Module metadata 

Source
Expand description

The metadata module contains functions for extracting and processing metadata. Metadata extraction and processing module.

This module provides functionality for extracting metadata from various formats (YAML, TOML, JSON) and processing it into a standardized structure.

Structs§

Metadata
Represents metadata for a page or content item.
ProcessOptions
Options for process_metadata_with.

Enums§

FrontMatterFormat
Which front-matter shape a document carries, and where its body starts.

Functions§

detect_front_matter
Locates the front-matter block without parsing it.
extract_metadata
Extracts metadata from the content string.
extract_metadata_with_body
Extracts metadata and returns the document body alongside it.
extract_typed
Deserialises the front matter into a typed value.
process_metadata
Processes the extracted metadata.
process_metadata_with
process_metadata with caller-chosen required fields and derivations.