aws_sdk_iottwinmaker/types/
_error_code.rs

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

aws_sdk_iottwinmaker/types/
_error_code.rs
