Struct ComposeFile 

pub struct ComposeFile {
    pub name: Option<String>,
    pub include: BTreeSet<Include>,
    pub services: BTreeMap<String, Service>,
    pub configs: BTreeMap<String, TopLevelConfig>,
    pub models: BTreeMap<String, TopLevelModel>,
    pub networks: BTreeMap<String, TopLevelNetwork>,
    pub secrets: BTreeMap<String, TopLevelSecret>,
    pub volumes: BTreeMap<String, TopLevelVolume>,
    pub extensions: BTreeMap<String, Value>,
}

Configuration settings for a Docker Compose file.

Fields

name: Option<String>

The top-level name property is defined by the Compose Specification as the project name to be used if you don’t set one explicitly.

See more: https://docs.docker.com/reference/compose-file/version-and-name/#name-top-level-element

include: BTreeSet<Include>

Requires: Docker Compose 2.20.0 and later

The include top-level section is used to define the dependency on another Compose application, or sub-domain. Each path listed in the include section is loaded as an individual Compose application model, with its own project directory, in order to resolve relative paths.

See more: https://docs.docker.com/reference/compose-file/include/

services: BTreeMap<String, Service>

configs: BTreeMap<String, TopLevelConfig>

Defines or references configuration data that is granted to services in your Compose application.

See more: https://docs.docker.com/reference/compose-file/configs/

models: BTreeMap<String, TopLevelModel>

The top-level models section declares AI models that are used by your Compose application. These models are typically pulled as OCI artifacts, run by a model runner, and exposed as an API that your service containers can consume.

See more: https://docs.docker.com/reference/compose-file/models/

networks: BTreeMap<String, TopLevelNetwork>

The named networks for the Compose application.

See more: https://docs.docker.com/reference/compose-file/networks/

secrets: BTreeMap<String, TopLevelSecret>

The named secrets for the Compose application.

See more: https://docs.docker.com/reference/compose-file/secrets/

volumes: BTreeMap<String, TopLevelVolume>

The named volumes for the Compose application.

See more: https://docs.docker.com/reference/compose-file/volumes/

extensions: BTreeMap<String, Value>

Implementations

impl ComposeFile

pub fn new() -> Self

Trait Implementations

impl Clone for ComposeFile

fn clone(&self) -> ComposeFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComposeFile

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

Formats the value using the given formatter.

impl Default for ComposeFile

fn default() -> ComposeFile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComposeFile

where ComposeFile: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Merge for ComposeFile

fn merge(&mut self, other: Self)

impl PartialEq for ComposeFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ComposeFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ComposeFile