#docker-compose #compose #yaml #serialization #deserialize #strongly-typed #file

docker-compose-types

Deserialization and Serialization of docker-compose.yml files in a relatively strongly typed fashion

24 releases

0.7.2 Mar 1, 2024
0.7.0 Dec 12, 2023
0.6.1 Nov 13, 2023
0.5.2 Jul 31, 2023
0.1.5 Jul 5, 2021

#209 in Data structures

Download history 31/week @ 2023-12-24 86/week @ 2023-12-31 189/week @ 2024-01-07 218/week @ 2024-01-14 180/week @ 2024-01-21 427/week @ 2024-01-28 216/week @ 2024-02-04 150/week @ 2024-02-11 140/week @ 2024-02-18 502/week @ 2024-02-25 464/week @ 2024-03-03 331/week @ 2024-03-10 296/week @ 2024-03-17 72/week @ 2024-03-24 360/week @ 2024-03-31 267/week @ 2024-04-07

1,011 downloads per month
Used in 3 crates

MIT/Apache

34KB
816 lines

Docker Compose Types

crates.io

Contributions are very welcome, the idea behind this crate is to allow for safe serialization of docker-compose files with as little room for error as possible.

Example Usage

Parsing a docker-compose file

use docker_compose_types::Compose;

fn main() {
    let file_payload =
        std::fs::read_to_string("tests/fixtures/v3-full/docker-compose.yml").unwrap();
    let compose_content = match serde_yaml::from_str::<Compose>(&file_payload) {
        Ok(c) => c,
        Err(e) => panic!("Failed to parse docker-compose file: {}", e),
    };
    println!("Parsed docker-compose file: {:#?}", compose_content);
}

Creating a docker-compose file from the crate's types

use docker_compose_types::{Compose, Service, Services, SingleService};
use serde_yaml;

fn main() {
    let compose_content = Compose {
        version: Some("3.8".to_string()),
        services: {
            let mut services = indexmap::IndexMap::new();
            services.insert(
                "web".to_string(),
                Some(Service {
                    image: Some("nginx:latest".to_string()),
                    ..Default::default()
                }),
            );
            Some(Services(services))
        },
        ..Default::default()
    };

    let target_file = std::path::Path::new("docker-compose.yml");
    // serialize to string
    let serialized = match serde_yaml::to_string(&compose_content) {
        Ok(s) => s,
        Err(e) => panic!("Failed to serialize docker-compose file: {}", e),
    };
    // serialize to file
    std::fs::write(target_file, serialized).unwrap();
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~4MB
~83K SLoC