Skip to main content

Module render

Module render 

Source
Expand description

Deterministic rendering and preservation-oriented editing of ComposeLens-owned documents.

Structs§

CanonicalFormatting
Presentation-only options for deterministic merged-project rendering.
CanonicalRender
The result of deterministic canonical rendering.
ComposeDocumentBuilder
Builder for one new deterministic Compose document.
GeneratedComposeDocument
Parse-back-validated deterministic generated Compose document.
GeneratedEnvironment
One ordered Compose environment entry.
GeneratedExtraHost
One ordered Compose extra_hosts relationship.
GeneratedLabel
One generated service metadata label.
GeneratedMount
One generated service mount with deliberate short/long syntax selection.
GeneratedNetworkAttachment
One generated service network attachment and its ordered aliases.
GeneratedPort
One generated Compose port entry with protocol-aware syntax selection.
GeneratedResource
One top-level network or volume lifecycle definition.
GeneratedService
A typed generated Compose service definition.
GeneratedString
A plain or sensitive string used by generated Compose fields.
IndentWidth
A valid number of spaces used for one canonical YAML indentation level.
PreservationEditResult
The result of applying an atomic batch of preservation-oriented scalar edits.
ReplacementScalar
A typed scalar value to place at an existing YAML value-scalar span.
ScalarEdit
One exact value-scalar replacement in a syntax document.

Enums§

GeneratedCommand
Compose command form selected for a generated service.
GeneratedProtocol
Transport protocol for one generated published port.
GeneratedSelinux
SELinux relabel option that requires Compose short bind syntax.
GenerationError
A generated Compose value is empty or contains a NUL byte.
LineEnding
A presentation-only line-ending choice for rendered YAML.

Constants§

EDIT_INVALID_NUMBER
A requested numeric spelling is not one complete YAML number scalar.
EDIT_OVERLAP
Two requested edits modify overlapping source ranges.
EDIT_SOURCE_MISMATCH
An edit targets a source document other than the supplied syntax document.
EDIT_TARGET_NOT_SCALAR
An edit target is not exactly one YAML value scalar.
EDIT_UNSUPPORTED_SCALAR_STYLE
The authored scalar style cannot yet be replaced without risking surrounding syntax.
UNRENDERABLE_ALIAS
An unresolved alias cannot be represented in a standalone canonical document.
UNRENDERABLE_TAG
A retained YAML tag is not safe to emit as a canonical tag token.

Functions§

apply_preservation_edits
Applies exact value-scalar replacements while retaining every unrelated source byte.
render_canonical
Renders a merged project as deterministic ComposeLens canonical YAML.
render_canonical_with_formatting
Renders a merged project with explicit presentation-only formatting choices.