use-platform 0.1.0

Primitive platform identity and target triple vocabulary for RustUse
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use core::{fmt, str::FromStr};
use std::error::Error;

/// A plain, owned platform triple value.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct PlatformTriple(String);

impl PlatformTriple {
    /// Creates a platform triple from non-empty text.
    ///
    /// # Errors
    ///
    /// Returns [`PlatformTripleError::Empty`] when the trimmed input is empty.
    pub fn new(value: impl AsRef<str>) -> Result<Self, PlatformTripleError> {
        let trimmed = value.as_ref().trim();

        if trimmed.is_empty() {
            return Err(PlatformTripleError::Empty);
        }

        Ok(Self(trimmed.to_string()))
    }

    /// Returns the platform triple text.
    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }

    /// Consumes the triple and returns the owned string.
    #[must_use]
    pub fn into_string(self) -> String {
        self.0
    }
}

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

impl fmt::Display for PlatformTriple {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for PlatformTriple {
    type Err = PlatformTripleError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::new(value)
    }
}

/// Errors returned while constructing platform vocabulary.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum PlatformTripleError {
    /// The platform triple was empty after trimming whitespace.
    Empty,
}

impl fmt::Display for PlatformTripleError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Empty => formatter.write_str("platform triple cannot be empty"),
        }
    }
}

impl Error for PlatformTripleError {}

/// A plain platform identity value backed by a platform triple.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Platform {
    triple: PlatformTriple,
}

impl Platform {
    /// Creates a platform from an already modeled platform triple.
    #[must_use]
    pub const fn new(triple: PlatformTriple) -> Self {
        Self { triple }
    }

    /// Returns the platform triple.
    #[must_use]
    pub const fn triple(&self) -> &PlatformTriple {
        &self.triple
    }

    /// Consumes the platform and returns the platform triple.
    #[must_use]
    pub fn into_triple(self) -> PlatformTriple {
        self.triple
    }
}

impl From<PlatformTriple> for Platform {
    fn from(triple: PlatformTriple) -> Self {
        Self::new(triple)
    }
}

impl fmt::Display for Platform {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.triple.fmt(formatter)
    }
}

#[cfg(test)]
mod tests {
    use super::{Platform, PlatformTriple, PlatformTripleError};

    #[test]
    fn accepts_common_platform_triples() {
        for triple in [
            "x86_64-unknown-linux-gnu",
            "aarch64-apple-darwin",
            "wasm32-wasip1",
        ] {
            assert_eq!(PlatformTriple::new(triple).unwrap().as_str(), triple);
        }
    }

    #[test]
    fn rejects_empty_platform_triples() {
        assert_eq!(PlatformTriple::new("  "), Err(PlatformTripleError::Empty));
    }

    #[test]
    fn display_round_trips_through_parse() {
        let triple = PlatformTriple::new("x86_64-pc-windows-msvc").unwrap();
        let round_trip: PlatformTriple = triple.to_string().parse().unwrap();

        assert_eq!(round_trip, triple);
    }

    #[test]
    fn platform_wraps_a_triple_without_detection() {
        let triple = PlatformTriple::new("aarch64-apple-darwin").unwrap();
        let platform = Platform::new(triple.clone());

        assert_eq!(platform.triple(), &triple);
        assert_eq!(platform.to_string(), "aarch64-apple-darwin");
    }
}