compose_spec 0.3.0

Types for (de)serializing from/to the compose-spec
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Provides [`Network`] for the `network` field of the long [`Build`](super::Build) syntax.

use std::{
    borrow::Cow,
    fmt::{self, Display, Formatter},
};

use compose_spec_macros::{DeserializeTryFromString, SerializeDisplay};

use crate::{impl_from_str, Identifier, InvalidIdentifierError};

/// Network containers connect to during [`Build`](super::Build) for `RUN` instructions.
///
/// [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/build.md#network)
#[derive(SerializeDisplay, DeserializeTryFromString, Debug, Clone, PartialEq, Eq)]
pub enum Network {
    /// Network to connect to during build.
    Identifier(Identifier),

    /// Disable networking during build.
    None,
}

impl Network {
    /// [`Self::None`] string value.
    const NONE: &'static str = "none";

    /// Parse [`Network`] from a string.
    ///
    /// "none" converts to [`Network::None`].
    ///
    /// # Errors
    ///
    /// Returns an error if the network is not a valid [`Identifier`]
    pub fn parse<T>(network: T) -> Result<Self, T::Error>
    where
        T: AsRef<str> + TryInto<Identifier>,
    {
        if network.as_ref() == Self::NONE {
            Ok(Self::None)
        } else {
            network.try_into().map(Self::Identifier)
        }
    }

    /// String slice of the [`Network`].
    ///
    /// If [`None`](Network::None), "none" is returned.
    #[must_use]
    pub fn as_str(&self) -> &str {
        match self {
            Self::Identifier(network) => network.as_str(),
            Self::None => Self::NONE,
        }
    }

    /// Returns `true` if the network is [`None`].
    ///
    /// [`None`]: Network::None
    #[must_use]
    pub const fn is_none(&self) -> bool {
        matches!(self, Self::None)
    }

    /// Convert into [`Option<String>`].
    ///
    /// [`Network::Identifier`] converts into [`Option::Some`] and [`Network::None`] into
    /// [`Option::None`].
    #[must_use]
    pub fn into_option(self) -> Option<Identifier> {
        match self {
            Self::Identifier(network) => Some(network),
            Self::None => None,
        }
    }
}

impl_from_str!(Network => InvalidIdentifierError);

impl AsRef<str> for Network {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl Display for Network {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

impl From<Network> for Cow<'static, str> {
    fn from(value: Network) -> Self {
        match value {
            Network::Identifier(network) => Self::Owned(network.into()),
            Network::None => Self::Borrowed(Network::NONE),
        }
    }
}

impl From<Network> for String {
    fn from(value: Network) -> Self {
        Cow::from(value).into_owned()
    }
}