Expand description
Source-aware native Compose document types.
Structs§
- Bind
Options - Bind-specific options in a long-syntax mount.
- Build
Definition - A long-syntax build definition.
- Build
Field - One recognized build subfield and its source reference.
- Compose
Document - A source-aware native Compose document.
- Config
Definition - A typed top-level config definition.
- Container
Path - A container-side mount path classified independently of the host operating system.
- Deploy
Definition - A deploy definition split into independently classifiable fields.
- Deploy
Field - One recognized deploy subfield and its source reference.
- Environment
List Entry - One array-syntax environment entry.
- Environment
MapEntry - One mapping-syntax environment entry.
- Field
Reference - Source provenance for an extension or not-yet-typed field.
- Healthcheck
- A service health-check definition.
- Host
Address - A host address classified without normalizing its authored spelling.
- Image
Digest - A parsed digest suffix that remains tolerant of implementation extensions.
- Image
Reference - A loss-aware, tolerant image reference.
- Ipam
- Top-level network IPAM configuration.
- Ipam
Config - One top-level IPAM subnet configuration.
- KeyValue
Entry - One source-aware key/value entry from a Compose mapping.
- Located
- A typed value and the exact source span from which it was read.
- Long
Extra Host - One mapping-syntax
extra_hostsentry. - Long
Grant - Long syntax shared by service config and secret grants.
- Long
Port - A long-syntax published port.
- Long
Volume Mount - A long-syntax service-volume mount.
- Model
Parse - A recoverable typed-model parse result.
- Network
Definition - A typed top-level Compose network definition.
- Secret
Definition - A typed top-level secret definition.
- Service
- A source-aware typed Compose service.
- Service
Dependency - One long-syntax service dependency.
- Service
Network - Options for one service attachment to a network.
- Short
Extra Host - One short-syntax
extra_hostsentry. - Short
Port - A short-syntax published port.
- Short
Volume Mount - A short-syntax service-volume mount.
- Ulimit
- One named service limit.
- Ulimit
Range - Long syntax with independent soft and hard limits.
- Ulimits
- A service
ulimitsmapping. - User
Namespace Mode - A service
userns_modevalue. - User
Spec - A service
uservalue with optional user/group decomposition. - Volume
Definition - A typed top-level volume definition.
Enums§
- Boolean
Value - A Compose boolean before optional interpolation is evaluated.
- Build
- A Compose build declaration with short and long forms retained.
- Build
Field Kind - Recognized fields from the current Compose Build Specification.
- Command
- A Compose service command with null, scalar, and list forms retained.
- Compose
Scalar - A YAML scalar retained without applying Compose interpolation or coercion.
- Config
Grant - A service config grant with its syntax form retained.
- Container
Path Kind - The lexical family of a container-side path.
- Dependency
Condition - A long-syntax dependency condition.
- Depends
On - A service dependency collection with its authored form retained.
- Deploy
Field Kind - Recognized fields from the current Compose Deploy Specification.
- Environment
- A service environment with array or mapping syntax retained.
- Extra
Host Separator - The separator used by one short
extra_hostsentry. - Extra
Hosts - The authored collection form of
extra_hosts. - Healthcheck
Duration - A health-check duration retained before interpolation.
- Healthcheck
Retries - A health-check retry count retained before interpolation.
- Healthcheck
Test - A health-check command with scalar and list forms kept distinct.
- Healthcheck
Test Kind - The command-mode token at the beginning of a health-check list.
- Host
Address Kind - The lexical kind of a host address.
- Identity
Component - One lexical component of a container user/group value.
- Labels
- A Compose labels value with its list or mapping form retained.
- Limit
Value - A scalar resource-limit value.
- Mount
Type - A long-syntax service-volume mount type.
- Port
- A service port with its authored short or long form retained.
- Secret
Grant - A service secret grant with its syntax form retained.
- Selinux
Relabel - A requested
SELinuxrelabel mode. - Service
Networks - Service network syntax, retained as a sequence or mapping.
- Ulimit
Value - The authored form of one service limit.
- User
Namespace Mode Kind - The recognized family of a
userns_modevalue. - Volume
Mount - A service-volume mount with its authored syntax form retained.
- Volume
Syntax - The authored Compose syntax form of a service-volume mount.
Constants§
- DEPENDENCY_
HEALTHCHECK_ UNVERIFIED - A
service_healthydependency may rely on health metadata from its image. - DEPENDENCY_
INVALID_ CONDITION - A long dependency uses an unrecognized condition.
- DEPENDENCY_
MISSING_ HEALTHCHECK - A
service_healthydependency 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_hostsentry 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 ComposeLenscurrently 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
SELinuxvalue. - VOLUME_
MISSING_ TARGET - A long-syntax service volume is missing
target. - VOLUME_
MISSING_ TYPE - A long-syntax service volume is missing
type.