aws_sdk_pinpoint/types/
_state.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// When writing a match expression against `State`, 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 state = unimplemented!();
14/// match state {
15///     State::Active => { /* ... */ },
16///     State::Cancelled => { /* ... */ },
17///     State::Closed => { /* ... */ },
18///     State::Completed => { /* ... */ },
19///     State::Draft => { /* ... */ },
20///     State::Paused => { /* ... */ },
21///     other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
22///     _ => { /* ... */ },
23/// }
24/// ```
25/// The above code demonstrates that when `state` represents
26/// `NewFeature`, the execution path will lead to the second last match arm,
27/// even though the enum does not contain a variant `State::NewFeature`
28/// in the current version of SDK. The reason is that the variable `other`,
29/// created by the `@` operator, is bound to
30/// `State::Unknown(UnknownVariantValue("NewFeature".to_owned()))`
31/// and calling `as_str` on it yields `"NewFeature"`.
32/// This match expression is forward-compatible when executed with a newer
33/// version of SDK where the variant `State::NewFeature` is defined.
34/// Specifically, when `state` represents `NewFeature`,
35/// the execution path will hit the second last match arm as before by virtue of
36/// calling `as_str` on `State::NewFeature` also yielding `"NewFeature"`.
37///
38/// Explicitly matching on the `Unknown` variant should
39/// be avoided for two reasons:
40/// - The inner data `UnknownVariantValue` is opaque, and no further information can be extracted.
41/// - It might inadvertently shadow other intended match arms.
42///
43#[allow(missing_docs)] // documentation missing in model
44#[non_exhaustive]
45#[derive(
46    ::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
47)]
48pub enum State {
49    #[allow(missing_docs)] // documentation missing in model
50    Active,
51    #[allow(missing_docs)] // documentation missing in model
52    Cancelled,
53    #[allow(missing_docs)] // documentation missing in model
54    Closed,
55    #[allow(missing_docs)] // documentation missing in model
56    Completed,
57    #[allow(missing_docs)] // documentation missing in model
58    Draft,
59    #[allow(missing_docs)] // documentation missing in model
60    Paused,
61    /// `Unknown` contains new variants that have been added since this code was generated.
62    #[deprecated(note = "Don't directly match on `Unknown`. See the docs on this enum for the correct way to handle unknown variants.")]
63    Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue),
64}
65impl ::std::convert::From<&str> for State {
66    fn from(s: &str) -> Self {
67        match s {
68            "ACTIVE" => State::Active,
69            "CANCELLED" => State::Cancelled,
70            "CLOSED" => State::Closed,
71            "COMPLETED" => State::Completed,
72            "DRAFT" => State::Draft,
73            "PAUSED" => State::Paused,
74            other => State::Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue(other.to_owned())),
75        }
76    }
77}
78impl ::std::str::FromStr for State {
79    type Err = ::std::convert::Infallible;
80
81    fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
82        ::std::result::Result::Ok(State::from(s))
83    }
84}
85impl State {
86    /// Returns the `&str` value of the enum member.
87    pub fn as_str(&self) -> &str {
88        match self {
89            State::Active => "ACTIVE",
90            State::Cancelled => "CANCELLED",
91            State::Closed => "CLOSED",
92            State::Completed => "COMPLETED",
93            State::Draft => "DRAFT",
94            State::Paused => "PAUSED",
95            State::Unknown(value) => value.as_str(),
96        }
97    }
98    /// Returns all the `&str` representations of the enum members.
99    pub const fn values() -> &'static [&'static str] {
100        &["ACTIVE", "CANCELLED", "CLOSED", "COMPLETED", "DRAFT", "PAUSED"]
101    }
102}
103impl ::std::convert::AsRef<str> for State {
104    fn as_ref(&self) -> &str {
105        self.as_str()
106    }
107}
108impl State {
109    /// Parses the enum value while disallowing unknown variants.
110    ///
111    /// Unknown variants will result in an error.
112    pub fn try_parse(value: &str) -> ::std::result::Result<Self, crate::error::UnknownVariantError> {
113        match Self::from(value) {
114            #[allow(deprecated)]
115            Self::Unknown(_) => ::std::result::Result::Err(crate::error::UnknownVariantError::new(value)),
116            known => Ok(known),
117        }
118    }
119}
120impl ::std::fmt::Display for State {
121    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
122        match self {
123            State::Active => write!(f, "ACTIVE"),
124            State::Cancelled => write!(f, "CANCELLED"),
125            State::Closed => write!(f, "CLOSED"),
126            State::Completed => write!(f, "COMPLETED"),
127            State::Draft => write!(f, "DRAFT"),
128            State::Paused => write!(f, "PAUSED"),
129            State::Unknown(value) => write!(f, "{}", value),
130        }
131    }
132}
aws_sdk_pinpoint/types/_state.rs

aws_sdk_pinpoint/types/
_state.rs
