Crate ephemeris_documents 

Renders desired text, structured, and Markdown documents, and reconciles them with existing source while keeping the parts the user owns.

Modules

annotation 🔒

Inline annotations embedded in structured document values.

backend 🔒

Parsing, building and reconciling documents for a format.

columns 🔒

A positive column count.

entries 🔒

Object entries in render order.

error 🔒

Error types of the crate.

format 🔒

The output format of a structured document, its capabilities and its dispatch to a backend.

header 🔒

The generated comment at the start of a document.

json 🔒

JSON and JSON5 support: the dialects, the syntax tree, and the backend.

line_ending 🔒

Line ending settings, detection and conversion.

markdown 🔒

Markdown documents: rendering whole documents and reconciling selected regions.

merge 🔒

The format independent merge of a desired tree into a current one.

ownership 🔒

Ownership declarations and the claims they make on key paths.

path 🔒

Locations inside a structured value, for error messages.

scalar 🔒

Leaf values of an annotated tree.

source 🔒

The current source of a document, decoded once.

spec 🔒

The wire shape of a document and its dispatch to a payload type.

text 🔒

Plain text documents.

toml 🔒

TOML support: the backend, its node edits, and the canonical rendering.

yaml 🔒

YAML support: canonical rendering of a whole tree, the source tree that edits existing YAML, and the backend.

Structs

HeadingLevel

A heading level from 1 to 6.

InlineWidth

Widest key = { ... } line, in columns, that stays an inline table. Wider tables are promoted to [table] sections.

JsonError

Error returned while parsing a JSON or JSON5 document.

KeyPath

The location of a value inside a document, such as jobs.build.steps[2].

ManagedPath

A nonempty key path selected for management in a structured document.

MarkdownSpec

A Markdown document.

MarkerNameBuf

An owned marker name, validated when it is decoded.

Siblings

A container that gains a new key, which should look like its siblings.

StructuredSpec

A structured (JSON, JSON5, TOML, or YAML) document.

TextSpec

A plain text document, rendered node by node.

Wrap

A positive column count for wrapping text.

Enums

AnnotationError

Error returned while decoding inline annotation markers.

ColumnsError

Error returned for an invalid column count.

CommentSyntax

Comment delimiter for plain text formats that support comments.

DocumentError

Error returned by document validation, rendering, and reconciliation.

DocumentNode

A comment or literal text node in a plain text document.

DocumentOwnership

Ownership mode shared by structured document formats.

DocumentSpec

A complete desired document or a source-preserving partial document.

Feature

A capability a format may lack.

Format

Output syntax for a structured document.

InternalError

A failure that is a bug in this crate, not a problem with the input.

JsonErrorKind

The reason a JSON or JSON5 document failed to parse.

LineEndingError

Error returned while resolving a document’s line ending.

LineEndingSpec

The line ending setting of a document on the wire.

MarkdownBlock

A block-level Markdown element.

MarkdownError

Error returned while validating, rendering, or reconciling Markdown.

MarkdownInline

Inline Markdown content within a block.

MarkdownOwnership

Ownership mode for a Markdown document.

MarkdownSelector

A selector naming one region of an existing Markdown document to manage.

MarkerField

A field of an annotation marker.

MergeError

Error returned while merging a desired document into a current one.

OwnershipError

Error returned while validating ownership declarations.

PathSyntaxError

What is wrong in the text of an ownership path.

Segment

One step of a KeyPath.

TextError

Error returned while rendering a plain text document’s comment nodes.

TomlError

Error returned while rendering or reconciling a TOML document.

ValueError

Error returned while shaping a generic value for a structured format.

YamlError

Error returned while reading a YAML source tree.

Functions

is_generated

Whether the first line of content is a comment that holds the generated marker. Every comment syntax is accepted.