compose_yml 0.0.59

Parse, manipulate and serialize docker-compose.yml in a strongly-typed fashion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use super::common::*;

/// A service which will be managed by `docker-compose`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(deny_unknown_fields)]
pub struct Network {
    /// The name of the network driver to use.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub driver: Option<RawOr<String>>,

    /// Options to pass to the network driver.
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub driver_opts: BTreeMap<String, RawOr<String>>,

    /// Mutually-exclusive with all other options.
    ///
    /// TODO LOW: We could represent `Network` and `ExternalNetwork` as
    /// some kind of enum, but that might break in the future if things get
    /// more complicated.  For now, we're sticking close to the file
    /// format even if it makes things a bit less idiomatic in Rust.
    ///
    /// TODO LOW: Clear on merge if `driver` changes, like we do for
    /// `Logging` options.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        serialize_with = "serialize_opt_true_or_struct",
        deserialize_with = "deserialize_opt_true_or_struct"
    )]
    pub external: Option<ExternalNetwork>,

    /// Create a network which has no access to the outside world.
    #[serde(default, skip_serializing_if = "is_false")]
    pub internal: bool,

    /// Enable IPv6 for this network.
    #[serde(default, skip_serializing_if = "is_false")]
    pub enable_ipv6: bool,

    /// Docker labels for this volume, specifying various sorts of
    /// custom metadata.
    #[serde(
        default,
        skip_serializing_if = "BTreeMap::is_empty",
        deserialize_with = "deserialize_map_or_key_value_list"
    )]
    pub labels: BTreeMap<String, RawOr<String>>,

    // TODO LOW: ipam
    /// PRIVATE.  Mark this struct as having unknown fields for future
    /// compatibility.  This prevents direct construction and exhaustive
    /// matching.  This needs to be be public because of
    /// http://stackoverflow.com/q/39277157/12089
    #[doc(hidden)]
    #[serde(default, skip_serializing, skip_deserializing)]
    pub _hidden: (),
}

derive_standard_impls_for!(Network, {
    driver, driver_opts, external, internal, enable_ipv6, labels, _hidden
});

#[test]
fn network_handles_driver_correctly() {
    let yaml = r#"---
driver: default
enable_ipv6: true
internal: true
labels:
  com.example: foo
"#;
    assert_roundtrip!(Network, yaml);
}

#[test]
fn network_handles_external_true_correctly() {
    let yaml = r#"---
external: true
"#;
    assert_roundtrip!(Network, yaml);
}

#[test]
fn network_handles_external_name_correctly() {
    let yaml = r#"---
external:
  name: bridge
"#;
    assert_roundtrip!(Network, yaml);
}