aws_sdk_mediaconnect/types/
_key_type.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// When writing a match expression against `KeyType`, it is important to ensure
4/// your code is forward-compatible. That is, if a match arm handles a case for a
5/// feature that is supported by the service but has not been represented as an enum
6/// variant in a current version of SDK, your code should continue to work when you
7/// upgrade SDK to a future version in which the enum does include a variant for that
8/// feature.
9///
10/// Here is an example of how you can make a match expression forward-compatible:
11///
12/// ```text
13/// # let keytype = unimplemented!();
14/// match keytype {
15///     KeyType::Speke => { /* ... */ },
16///     KeyType::SrtPassword => { /* ... */ },
17///     KeyType::StaticKey => { /* ... */ },
18///     other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
19///     _ => { /* ... */ },
20/// }
21/// ```
22/// The above code demonstrates that when `keytype` represents
23/// `NewFeature`, the execution path will lead to the second last match arm,
24/// even though the enum does not contain a variant `KeyType::NewFeature`
25/// in the current version of SDK. The reason is that the variable `other`,
26/// created by the `@` operator, is bound to
27/// `KeyType::Unknown(UnknownVariantValue("NewFeature".to_owned()))`
28/// and calling `as_str` on it yields `"NewFeature"`.
29/// This match expression is forward-compatible when executed with a newer
30/// version of SDK where the variant `KeyType::NewFeature` is defined.
31/// Specifically, when `keytype` represents `NewFeature`,
32/// the execution path will hit the second last match arm as before by virtue of
33/// calling `as_str` on `KeyType::NewFeature` also yielding `"NewFeature"`.
34///
35/// Explicitly matching on the `Unknown` variant should
36/// be avoided for two reasons:
37/// - The inner data `UnknownVariantValue` is opaque, and no further information can be extracted.
38/// - It might inadvertently shadow other intended match arms.
39///
40#[allow(missing_docs)] // documentation missing in model
41#[non_exhaustive]
42#[derive(
43    ::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
44)]
45pub enum KeyType {
46    #[allow(missing_docs)] // documentation missing in model
47    Speke,
48    #[allow(missing_docs)] // documentation missing in model
49    SrtPassword,
50    #[allow(missing_docs)] // documentation missing in model
51    StaticKey,
52    /// `Unknown` contains new variants that have been added since this code was generated.
53    #[deprecated(note = "Don't directly match on `Unknown`. See the docs on this enum for the correct way to handle unknown variants.")]
54    Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue),
55}
56impl ::std::convert::From<&str> for KeyType {
57    fn from(s: &str) -> Self {
58        match s {
59            "speke" => KeyType::Speke,
60            "srt-password" => KeyType::SrtPassword,
61            "static-key" => KeyType::StaticKey,
62            other => KeyType::Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue(other.to_owned())),
63        }
64    }
65}
66impl ::std::str::FromStr for KeyType {
67    type Err = ::std::convert::Infallible;
68
69    fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
70        ::std::result::Result::Ok(KeyType::from(s))
71    }
72}
73impl KeyType {
74    /// Returns the `&str` value of the enum member.
75    pub fn as_str(&self) -> &str {
76        match self {
77            KeyType::Speke => "speke",
78            KeyType::SrtPassword => "srt-password",
79            KeyType::StaticKey => "static-key",
80            KeyType::Unknown(value) => value.as_str(),
81        }
82    }
83    /// Returns all the `&str` representations of the enum members.
84    pub const fn values() -> &'static [&'static str] {
85        &["speke", "srt-password", "static-key"]
86    }
87}
88impl ::std::convert::AsRef<str> for KeyType {
89    fn as_ref(&self) -> &str {
90        self.as_str()
91    }
92}
93impl KeyType {
94    /// Parses the enum value while disallowing unknown variants.
95    ///
96    /// Unknown variants will result in an error.
97    pub fn try_parse(value: &str) -> ::std::result::Result<Self, crate::error::UnknownVariantError> {
98        match Self::from(value) {
99            #[allow(deprecated)]
100            Self::Unknown(_) => ::std::result::Result::Err(crate::error::UnknownVariantError::new(value)),
101            known => Ok(known),
102        }
103    }
104}
105impl ::std::fmt::Display for KeyType {
106    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
107        match self {
108            KeyType::Speke => write!(f, "speke"),
109            KeyType::SrtPassword => write!(f, "srt-password"),
110            KeyType::StaticKey => write!(f, "static-key"),
111            KeyType::Unknown(value) => write!(f, "{value}"),
112        }
113    }
114}
aws_sdk_mediaconnect/types/_key_type.rs

aws_sdk_mediaconnect/types/
_key_type.rs
