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.
ParseLimits
Resource limits applied while a front-matter block is parsed.
ProcessOptions
Options for process_metadata_with.

Enums§

DateOrder
The reading of a slash-separated date such as 01/02/2024.
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_metadata_with_limits
Extracts metadata like extract_metadata, under explicit ParseLimits.
extract_typed
Deserialises the front matter into a typed value.
extract_typed_borrowed
Deserialises the front matter into T while borrowing from content.
process_metadata
Processes the extracted metadata.
process_metadata_with
process_metadata with caller-chosen required fields and derivations.