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
Annotation - One generated service annotation with an explicit string value.
- Generated
Compose Document - Parse-back-validated deterministic generated Compose document.
- Generated
Config File Definition - One generated top-level config definition backed by a caller-supplied file spelling.
- Generated
Environment - One ordered Compose environment entry.
- Generated
Extra Host - One ordered Compose
extra_hostsrelationship. - Generated
Label - One generated Compose metadata label.
- Generated
Logging - Explicit service logging configuration for generated output.
- Generated
Logging Option - One ordered generated logging option.
- Generated
Long Device - One generated long-syntax service device.
- 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
Network Definition - A top-level network definition with optional driver configuration.
- Generated
Network Driver Option - One ordered generated network driver option.
- Generated
Port - One generated Compose port entry with protocol-aware syntax selection.
- Generated
Resource - One top-level network or volume lifecycle definition.
- Generated
Secret File Definition - One generated top-level secret definition backed by a caller-supplied file spelling.
- Generated
Service - A typed generated Compose service definition.
- Generated
String - A plain or sensitive string used by generated Compose fields.
- Generated
Sysctl - One ordered mapping-form generated sysctl assignment.
- Generated
Ulimit - One ordered generated service limit.
- Generated
Ulimits - Ordered generated service limits, including an explicit empty mapping.
- Generated
Volume Definition - A top-level application-owned volume definition with optional driver configuration.
- Generated
Volume Driver Option - One ordered generated volume driver option.
- 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
CpuRt Runtime - A generated
cpu_rt_runtimespelling with an explicit YAML scalar category. - Generated
Device - One generated service device with explicit short or long syntax.
- Generated
Dns - The exact service
dnsform selected for generated Compose output. - Generated
DnsSearch - The exact service
dns_searchform selected for generated Compose output. - Generated
Entrypoint - Compose entrypoint form selected for a generated service.
- Generated
Environment File - One ordered generated Compose
env_filedeclaration. - Generated
Environment File Format - Explicit parser mode for one generated long-syntax
env_fileentry. - Generated
Hostname - A resolved service hostname selected for generated Compose output.
- Generated
Logging Option Value - A generated logging-option value with an explicit YAML scalar kind.
- Generated
MemLimit - A safe explicit service memory limit selected for generated Compose output.
- Generated
Network Driver Option Value - A generated network driver-option value with an explicit YAML scalar kind.
- Generated
Pids Limit - A service-level Compose PID limit selected for generated output.
- Generated
Protocol - Transport protocol for one generated published port.
- Generated
Pull Policy - A documented service-level Compose image pull policy selected for generated output.
- Generated
Restart Policy - A valid service-level Compose restart policy selected for generated output.
- Generated
Selinux SELinuxrelabel option that requires Compose short bind syntax.- Generated
Service Runtime Field - Raw service resource and namespace fields selected for deterministic generated output.
String-bearing variants use minimal safe quoting so caller-selected spelling remains a YAML string;
cpu_rt_runtimeexplicitly selects either an integer microsecond scalar or a duration string. - Generated
ShmSize - A safe explicit service shared-memory size selected for generated Compose output.
- Generated
Sysctls - The mapping or list form selected for generated service
sysctls. - Generated
Tmpfs - The exact service-level
tmpfsform selected for generated Compose output. - Generated
Ulimit Value - The single or soft/hard form selected for one generated service limit.
- Generated
Volume Driver Option Value - A generated volume driver-option value with an explicit YAML scalar kind.
- Generation
Error - A generated Compose construction request is invalid or cannot be represented safely.
- 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.