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.
- Parse
Limits - Resource limits applied while a front-matter block is parsed.
- Process
Options - Options for
process_metadata_with.
Enums§
- Date
Order - The reading of a slash-separated date such as
01/02/2024. - Front
Matter Format - 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 explicitParseLimits. - extract_
typed - Deserialises the front matter into a typed value.
- extract_
typed_ borrowed - Deserialises the front matter into
Twhile borrowing fromcontent. - process_
metadata - Processes the extracted metadata.
- process_
metadata_ with process_metadatawith caller-chosen required fields and derivations.