Struct ComposeConfig 

pub struct ComposeConfig {
    pub version: Option<String>,
    pub services: HashMap<String, ServiceConfig>,
    pub volumes: HashMap<String, Option<VolumeDeclaration>>,
    pub networks: HashMap<String, Option<NetworkDeclaration>>,
}

Top-level compose file configuration.

Compatible with a subset of docker-compose v3 syntax:

version: "3"
services:
  web:
    image: nginx:latest
    ports: ["8080:80"]
    depends_on: [db]
  db:
    image: postgres:16
    environment:
      POSTGRES_PASSWORD: secret
    volumes: ["pgdata:/var/lib/postgresql/data"]
volumes:
  pgdata:
networks:
  default:

Fields

version: Option<String>

Compose file version (informational, not enforced).

services: HashMap<String, ServiceConfig>

Service definitions keyed by name.

volumes: HashMap<String, Option<VolumeDeclaration>>

Named volume declarations (value is currently unused, reserved for driver options).

networks: HashMap<String, Option<NetworkDeclaration>>

Named network declarations.

Implementations

impl ComposeConfig

pub fn from_yaml(yaml: &[u8]) -> Result<Self, Error>

Parse a compose config from YAML bytes.

pub fn from_yaml_str(yaml: &str) -> Result<Self, Error>

Parse a compose config from a YAML string.

pub fn service_order(&self) -> Result<Vec<String>, String>

Compute a topological ordering of services based on depends_on.

Returns an error if there is a dependency cycle.

Trait Implementations

impl Clone for ComposeConfig

fn clone(&self) -> ComposeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComposeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComposeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ComposeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.