Skip to content

Helpers to serialize and deserialize, and relatively safely update docker-compose.yml file.

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
Apache-2.0
LICENSE-MIT
Notifications You must be signed in to change notification settings

stephanbuys/docker-compose-types

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.

About

Helpers to serialize and deserialize, and relatively safely update docker-compose.yml file.

Resources

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
Apache-2.0
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages