Struct compose_spec::Compose

pub struct Compose {
    pub version: Option<String>,
    pub name: Option<Name>,
    pub include: Vec<ShortOrLong<PathBuf, Include>>,
    pub services: IndexMap<Identifier, Service>,
    pub networks: Networks,
    pub volumes: Volumes,
    pub configs: Configs,
    pub secrets: Secrets,
    pub extensions: Extensions,
}

The Compose file is a YAML file defining a containers based application.

Note that the Deserialize implementations of many types within Compose make use of Deserializer::deserialize_any(). This means that you should only attempt to deserialize from self-describing formats like YAML or JSON.

compose-spec

Fields

version: Option<String>

Declared for backward compatibility, ignored.

compose-spec

name: Option<Name>

Define the Compose project name, until user defines one explicitly.

compose-spec

include: Vec<ShortOrLong<PathBuf, Include>>

Compose sub-projects to be included.

compose-spec

services: IndexMap<Identifier, Service>

The Services (containerized computing components) of the application.

compose-spec

networks: Networks

Named networks for Services to communicate with each other.

compose-spec

volumes: Volumes

Named volumes which can be reused across multiple Services.

Volumes are persistent data stores implemented by the container engine.

compose-spec

configs: Configs

Configs allow Services to adapt their behavior without needing to rebuild the container image.

compose-spec

secrets: Secrets

Sensitive data that a Service may be granted access to.

compose-spec

extensions: Extensions

Extension values, which are (de)serialized via flattening.

compose-spec

Trait Implementations

impl Clone for Compose

fn clone(&self) -> Compose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Compose

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

Formats the value using the given formatter.

impl Default for Compose

fn default() -> Compose

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Compose

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Compose

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Compose

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 Compose