Skip to main content

Module model

Module model 

Source
Expand description

Source-aware native Compose document types.

Structs§

BindOptions
Bind-specific options in a long-syntax mount.
BuildDefinition
A long-syntax build definition.
BuildField
One recognized build subfield and its source reference.
ComposeDocument
A source-aware native Compose document.
ConfigDefinition
A typed top-level config definition.
ContainerPath
A container-side mount path classified independently of the host operating system.
DeployDefinition
A deploy definition split into independently classifiable fields.
DeployField
One recognized deploy subfield and its source reference.
EnvironmentListEntry
One array-syntax environment entry.
EnvironmentMapEntry
One mapping-syntax environment entry.
FieldReference
Source provenance for an extension or not-yet-typed field.
Healthcheck
A service health-check definition.
HostAddress
A host address classified without normalizing its authored spelling.
ImageDigest
A parsed digest suffix that remains tolerant of implementation extensions.
ImageReference
A loss-aware, tolerant image reference.
Ipam
Top-level network IPAM configuration.
IpamConfig
One top-level IPAM subnet configuration.
KeyValueEntry
One source-aware key/value entry from a Compose mapping.
Located
A typed value and the exact source span from which it was read.
LongExtraHost
One mapping-syntax extra_hosts entry.
LongGrant
Long syntax shared by service config and secret grants.
LongPort
A long-syntax published port.
LongVolumeMount
A long-syntax service-volume mount.
ModelParse
A recoverable typed-model parse result.
NetworkDefinition
A typed top-level Compose network definition.
SecretDefinition
A typed top-level secret definition.
Service
A source-aware typed Compose service.
ServiceDependency
One long-syntax service dependency.
ServiceNetwork
Options for one service attachment to a network.
ShortExtraHost
One short-syntax extra_hosts entry.
ShortPort
A short-syntax published port.
ShortVolumeMount
A short-syntax service-volume mount.
Ulimit
One named service limit.
UlimitRange
Long syntax with independent soft and hard limits.
Ulimits
A service ulimits mapping.
UserNamespaceMode
A service userns_mode value.
UserSpec
A service user value with optional user/group decomposition.
VolumeDefinition
A typed top-level volume definition.

Enums§

BooleanValue
A Compose boolean before optional interpolation is evaluated.
Build
A Compose build declaration with short and long forms retained.
BuildFieldKind
Recognized fields from the current Compose Build Specification.
Command
A Compose service command with null, scalar, and list forms retained.
ComposeScalar
A YAML scalar retained without applying Compose interpolation or coercion.
ConfigGrant
A service config grant with its syntax form retained.
ContainerPathKind
The lexical family of a container-side path.
DependencyCondition
A long-syntax dependency condition.
DependsOn
A service dependency collection with its authored form retained.
DeployFieldKind
Recognized fields from the current Compose Deploy Specification.
Environment
A service environment with array or mapping syntax retained.
ExtraHostSeparator
The separator used by one short extra_hosts entry.
ExtraHosts
The authored collection form of extra_hosts.
HealthcheckDuration
A health-check duration retained before interpolation.
HealthcheckRetries
A health-check retry count retained before interpolation.
HealthcheckTest
A health-check command with scalar and list forms kept distinct.
HealthcheckTestKind
The command-mode token at the beginning of a health-check list.
HostAddressKind
The lexical kind of a host address.
IdentityComponent
One lexical component of a container user/group value.
Labels
A Compose labels value with its list or mapping form retained.
LimitValue
A scalar resource-limit value.
MountType
A long-syntax service-volume mount type.
Port
A service port with its authored short or long form retained.
SecretGrant
A service secret grant with its syntax form retained.
SelinuxRelabel
A requested SELinux relabel mode.
ServiceNetworks
Service network syntax, retained as a sequence or mapping.
UlimitValue
The authored form of one service limit.
UserNamespaceModeKind
The recognized family of a userns_mode value.
VolumeMount
A service-volume mount with its authored syntax form retained.
VolumeSyntax
The authored Compose syntax form of a service-volume mount.

Constants§

DEPENDENCY_HEALTHCHECK_UNVERIFIED
A service_healthy dependency may rely on health metadata from its image.
DEPENDENCY_INVALID_CONDITION
A long dependency uses an unrecognized condition.
DEPENDENCY_MISSING_HEALTHCHECK
A service_healthy dependency has no enabled health check.
DEPENDENCY_MISSING_SERVICE
A typed dependency names a service missing from the same document.
DOCUMENT_ROOT_TYPE
A Compose document root must be a mapping.
DUPLICATE_FIELD
A mapping contains a duplicate field.
EXPECTED_BOOLEAN
A Compose value has to be a boolean at this location.
EXPECTED_FIELD_FORM
A field supports multiple Compose syntax forms, but the authored form is invalid here.
EXPECTED_MAPPING
A Compose value has to be a mapping at this location.
EXPECTED_SCALAR
A Compose value has to be a scalar at this location.
EXPECTED_SEQUENCE
A Compose value has to be a sequence at this location.
EXTRA_HOST_INVALID_ENTRY
A short extra_hosts entry does not contain a hostname/address separator.
GRANT_EXPECTED_FORM
A service config or secret grant is neither scalar short syntax nor mapping long syntax.
GRANT_MISSING_SOURCE
A long-syntax service config or secret grant is missing source.
HEALTHCHECK_INVALID_DURATION
A health-check duration does not follow Compose duration syntax.
HEALTHCHECK_INVALID_RETRIES
A health-check retry count is not a non-negative integer or deferred expression.
HEALTHCHECK_INVALID_TEST
A health-check list has no valid command-mode token.
MULTIPLE_DOCUMENTS
ComposeLens currently types the first document in a multi-document YAML stream.
PORT_EXPECTED_FORM
A service port is neither scalar short syntax nor mapping long syntax.
PORT_MISSING_TARGET
A long-syntax service port is missing target.
RESOURCE_EXPECTED_FORM
A top-level resource definition must be a mapping or an explicit null.
ULIMIT_INVALID_VALUE
A service limit is neither unlimited, a non-negative integer, nor deferred.
VOLUME_EXPECTED_FORM
A service-volume item is neither short nor long syntax.
VOLUME_INVALID_SELINUX
A long-syntax bind mount has an invalid SELinux value.
VOLUME_MISSING_TARGET
A long-syntax service volume is missing target.
VOLUME_MISSING_TYPE
A long-syntax service volume is missing type.