Expand description
Deterministic rendering and preservation-oriented editing of ComposeLens-owned documents.
Structs§
- Canonical
Formatting - Presentation-only options for deterministic merged-project rendering.
- Canonical
Render - The result of deterministic canonical rendering.
- Compose
Document Builder - Builder for one new deterministic Compose document.
- Generated
Compose Document - Parse-back-validated deterministic generated Compose document.
- Generated
Environment - One ordered Compose environment entry.
- Generated
Extra Host - One ordered Compose
extra_hostsrelationship. - Generated
Mount - One generated service mount with deliberate short/long syntax selection.
- Generated
Network Attachment - One generated service network attachment and its ordered aliases.
- Generated
Port - One generated Compose port entry with protocol-aware syntax selection.
- Generated
Resource - One top-level network or volume lifecycle definition.
- Generated
Service - A typed generated Compose service definition.
- Generated
String - A plain or sensitive string used by generated Compose fields.
- Indent
Width - A valid number of spaces used for one canonical YAML indentation level.
- Preservation
Edit Result - The result of applying an atomic batch of preservation-oriented scalar edits.
- Replacement
Scalar - A typed scalar value to place at an existing YAML value-scalar span.
- Scalar
Edit - One exact value-scalar replacement in a syntax document.
Enums§
- Generated
Command - Compose command form selected for a generated service.
- Generated
Protocol - Transport protocol for one generated published port.
- Generated
Selinux SELinuxrelabel option that requires Compose short bind syntax.- Generation
Error - A generated Compose value is empty or contains a NUL byte.
- Line
Ending - 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
ComposeLenscanonical YAML. - render_
canonical_ with_ formatting - Renders a merged project with explicit presentation-only formatting choices.