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.
GeneratedAnnotation
One generated service annotation with an explicit string value.
GeneratedComposeDocument
Parse-back-validated deterministic generated Compose document.
GeneratedConfigFileDefinition
One generated top-level config definition backed by a caller-supplied file spelling.
GeneratedEnvironment
One ordered Compose environment entry.
GeneratedExtraHost
One ordered Compose extra_hosts relationship.
GeneratedLabel
One generated Compose metadata label.
GeneratedLogging
Explicit service logging configuration for generated output.
GeneratedLoggingOption
One ordered generated logging option.
GeneratedLongDevice
One generated long-syntax service device.
GeneratedMount
One generated service mount with deliberate short/long syntax selection.
GeneratedNetworkAttachment
One generated service network attachment and its ordered aliases.
GeneratedNetworkDefinition
A top-level network definition with optional driver configuration.
GeneratedNetworkDriverOption
One ordered generated network driver option.
GeneratedPort
One generated Compose port entry with protocol-aware syntax selection.
GeneratedResource
One top-level network or volume lifecycle definition.
GeneratedSecretFileDefinition
One generated top-level secret definition backed by a caller-supplied file spelling.
GeneratedService
A typed generated Compose service definition.
GeneratedString
A plain or sensitive string used by generated Compose fields.
GeneratedSysctl
One ordered mapping-form generated sysctl assignment.
GeneratedUlimit
One ordered generated service limit.
GeneratedUlimits
Ordered generated service limits, including an explicit empty mapping.
GeneratedVolumeDefinition
A top-level application-owned volume definition with optional driver configuration.
GeneratedVolumeDriverOption
One ordered generated volume driver option.
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.
GeneratedCpuRtRuntime
A generated cpu_rt_runtime spelling with an explicit YAML scalar category.
GeneratedDevice
One generated service device with explicit short or long syntax.
GeneratedDns
The exact service dns form selected for generated Compose output.
GeneratedDnsSearch
The exact service dns_search form selected for generated Compose output.
GeneratedEntrypoint
Compose entrypoint form selected for a generated service.
GeneratedEnvironmentFile
One ordered generated Compose env_file declaration.
GeneratedEnvironmentFileFormat
Explicit parser mode for one generated long-syntax env_file entry.
GeneratedHostname
A resolved service hostname selected for generated Compose output.
GeneratedLoggingOptionValue
A generated logging-option value with an explicit YAML scalar kind.
GeneratedMemLimit
A safe explicit service memory limit selected for generated Compose output.
GeneratedNetworkDriverOptionValue
A generated network driver-option value with an explicit YAML scalar kind.
GeneratedPidsLimit
A service-level Compose PID limit selected for generated output.
GeneratedProtocol
Transport protocol for one generated published port.
GeneratedPullPolicy
A documented service-level Compose image pull policy selected for generated output.
GeneratedRestartPolicy
A valid service-level Compose restart policy selected for generated output.
GeneratedSelinux
SELinux relabel option that requires Compose short bind syntax.
GeneratedServiceRuntimeField
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_runtime explicitly selects either an integer microsecond scalar or a duration string.
GeneratedShmSize
A safe explicit service shared-memory size selected for generated Compose output.
GeneratedSysctls
The mapping or list form selected for generated service sysctls.
GeneratedTmpfs
The exact service-level tmpfs form selected for generated Compose output.
GeneratedUlimitValue
The single or soft/hard form selected for one generated service limit.
GeneratedVolumeDriverOptionValue
A generated volume driver-option value with an explicit YAML scalar kind.
GenerationError
A generated Compose construction request is invalid or cannot be represented safely.
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.