Struct Service 

pub struct Service { /* private fields */ }

A source-aware typed Compose service.

Implementations

impl Service

pub const fn name(&self) -> &Located<String>

Returns the service name.

pub const fn span(&self) -> SourceSpan

Returns the complete service definition span.

pub const fn hostname(&self) -> Option<&Hostname>

Returns the explicitly authored raw-preserving service hostname.

pub const fn container_name(&self) -> Option<&Located<String>>

Returns the explicitly authored runtime container name.

pub const fn image(&self) -> Option<&Located<ImageReference>>

Returns the explicitly authored image reference.

pub const fn platform(&self) -> Option<&Located<String>>

Returns the strict raw service platform string without OCI interpretation.

pub const fn entrypoint(&self) -> Option<&Entrypoint>

Returns the entrypoint without normalizing its authored form.

pub const fn command(&self) -> Option<&Command>

Returns the command without normalizing its authored form.

pub const fn credential_spec(&self) -> Option<&CredentialSpec>

Returns the authored credential-spec mapping without resolving its references.

pub const fn extends(&self) -> Option<&Extends>

Returns the authored raw extends directive without resolving its reference.

pub const fn provider(&self) -> Option<&Provider>

Returns the authored provider configuration without provider execution or discovery.

pub const fn post_start(&self) -> Option<&PostStartHooks>

Returns ordered post-start hooks without executing them or inferring lifecycle behavior.

pub const fn pre_stop(&self) -> Option<&PreStopHooks>

Returns ordered pre-stop hooks without executing them or inferring lifecycle behavior.

pub const fn pre_start(&self) -> Option<&PreStartHooks>

Returns ordered pre-start hooks without executing them or inferring lifecycle behavior.

pub const fn blkio_config(&self) -> Option<&BlkioConfig>

Returns authored block-I/O configuration without controller or runtime interpretation.

pub const fn cgroup(&self) -> Option<&CgroupNamespace>

Returns the authored cgroup namespace without controller or runtime interpretation.

pub const fn cgroup_parent(&self) -> Option<&Located<String>>

Returns the authored raw cgroup parent string without path or runtime interpretation.

pub const fn runtime(&self) -> Option<&Located<String>>

Returns the strict raw service runtime string without runtime interpretation.

pub const fn pull_refresh_after(&self) -> Option<&Located<String>>

Returns the strict raw service pull-refresh interval without refresh interpretation.

pub const fn attach(&self) -> Option<&Located<BooleanValue>>

Returns the authored attach choice without runtime interpretation.

pub const fn init(&self) -> Option<&Located<BooleanValue>>

Returns whether Compose should run its platform-specific init process.

pub const fn stdin_open(&self) -> Option<&Located<BooleanValue>>

Returns whether Compose should keep standard input open for the service.

pub const fn tty(&self) -> Option<&Located<BooleanValue>>

Returns whether Compose should allocate a terminal for the service.

pub const fn privileged(&self) -> Option<&Located<BooleanValue>>

Returns whether Compose should run the service with its privileged choice.

pub const fn environment(&self) -> Option<&Environment>

Returns environment variables with list and mapping forms kept distinct.

pub fn environment_files(&self) -> &[EnvironmentFile]

Returns service environment files in authored order with syntax retained.

pub const fn labels(&self) -> Option<&Labels>

Returns service metadata labels with list and mapping forms kept distinct.

pub const fn annotations(&self) -> Option<&Annotations>

Returns service annotations with list and mapping forms kept distinct.

pub const fn extra_hosts(&self) -> Option<&ExtraHosts>

Returns additional host mappings with short and long forms retained.

pub const fn user(&self) -> Option<&UserSpec>

Returns the raw-preserving container user/group value.

pub const fn userns_mode(&self) -> Option<&UserNamespaceMode>

Returns the raw-preserving user-namespace mode.

pub fn group_add(&self) -> &[Located<String>]

Returns supplementary groups in authored order without resolving names or IDs.

pub const fn cap_add(&self) -> Option<&CapabilityAdd>

Returns the explicitly authored capability-add sequence, including an explicit empty one.

pub const fn cap_drop(&self) -> Option<&CapabilityDrop>

Returns the explicitly authored capability-drop sequence, including an explicit empty one.

pub const fn devices(&self) -> Option<&Devices>

Returns the explicitly authored ordered device sequence, including an explicit empty one.

pub const fn dns(&self) -> Option<&Dns>

Returns raw service DNS servers with scalar and ordered-list forms retained.

pub const fn dns_options(&self) -> Option<&DnsOptions>

Returns the explicitly authored ordered DNS resolver-option sequence.

pub const fn dns_search(&self) -> Option<&DnsSearch>

Returns raw DNS search domains with scalar and ordered-list forms retained.

pub const fn expose(&self) -> Option<&Expose>

Returns the explicitly authored ordered exposed-port sequence.

pub const fn security_options(&self) -> Option<&SecurityOptions>

Returns the explicitly authored ordered raw service security options.

pub const fn working_dir(&self) -> Option<&Located<String>>

Returns the container working-directory override.

pub const fn read_only(&self) -> Option<&Located<BooleanValue>>

Returns the explicit read-only root-filesystem choice.

pub const fn pids_limit(&self) -> Option<&PidsLimit>

Returns the raw-preserving service PID limit.

pub const fn cpu_count(&self) -> Option<&Located<CpuCount>>

Returns the authored CPU-count scalar without quota or runtime interpretation.

pub const fn cpu_percent(&self) -> Option<&Located<CpuPercent>>

Returns the authored CPU-percentage scalar without CPU or runtime interpretation.

pub const fn cpu_period(&self) -> Option<&Located<CpuPeriod>>

Returns the authored CPU-period scalar without CPU or runtime interpretation.

pub const fn cpu_quota(&self) -> Option<&Located<CpuQuota>>

Returns the authored CPU-quota scalar without CPU or runtime interpretation.

pub const fn cpu_rt_period(&self) -> Option<&Located<CpuRtPeriod>>

Returns the authored real-time CPU-period scalar without CPU or runtime interpretation.

pub const fn shm_size(&self) -> Option<&ShmSize>

Returns the raw-preserving service shared-memory size.

pub const fn mem_limit(&self) -> Option<&MemLimit>

Returns the raw-preserving service memory limit.

pub const fn tmpfs(&self) -> Option<&Tmpfs>

Returns service-level temporary filesystems with scalar and list forms retained.

pub const fn sysctls(&self) -> Option<&Sysctls>

Returns service sysctls with mapping/list form and scalar spelling retained.

pub const fn logging(&self) -> Option<&Logging>

Returns service logging configuration with an uninterpreted driver and ordered options.

pub const fn pull_policy(&self) -> Option<&PullPolicy>

Returns the raw-preserving service image pull policy.

pub const fn restart(&self) -> Option<&RestartPolicy>

Returns the service-level container restart policy.

pub const fn stop_signal(&self) -> Option<&Located<String>>

Returns the explicitly authored signal used to stop the service.

pub const fn stop_grace_period(&self) -> Option<&Located<StopGracePeriod>>

Returns the raw-preserving service stop grace period.

pub const fn ulimits(&self) -> Option<&Ulimits>

Returns explicitly authored service resource limits.

pub const fn depends_on(&self) -> Option<&DependsOn>

Returns service dependencies with short and long forms retained.

pub const fn healthcheck(&self) -> Option<&Healthcheck>

Returns the service health-check definition.

pub const fn build(&self) -> Option<&Build>

Returns the build declaration with short and long forms retained.

pub const fn deploy(&self) -> Option<&DeployDefinition>

Returns independently classified deploy subfields.

pub fn ports(&self) -> &[Port]

Returns published ports in authored order.

pub fn volumes(&self) -> &[VolumeMount]

Returns service-volume mounts in authored order.

pub const fn networks(&self) -> Option<&ServiceNetworks>

Returns service network attachments with short and long forms kept distinct.

pub fn profiles(&self) -> &[Located<String>]

Returns explicitly authored profile names.

pub fn configs(&self) -> &[ConfigGrant]

Returns service config grants in authored order.

pub fn secrets(&self) -> &[SecretGrant]

Returns service secret grants in authored order.

pub fn extension_fields(&self) -> &[FieldReference]

Returns retained service x- extension fields.

pub fn unknown_fields(&self) -> &[FieldReference]

Returns service fields not yet represented by the typed subset.

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Service

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Service

impl PartialEq for Service

fn eq(&self, other: &Service) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Service