aws-sdk-pinpoint 0.36.0

AWS SDK for Amazon Pinpoint
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// When writing a match expression against `Layout`, it is important to ensure
/// your code is forward-compatible. That is, if a match arm handles a case for a
/// feature that is supported by the service but has not been represented as an enum
/// variant in a current version of SDK, your code should continue to work when you
/// upgrade SDK to a future version in which the enum does include a variant for that
/// feature.
///
/// Here is an example of how you can make a match expression forward-compatible:
///
/// ```text
/// # let layout = unimplemented!();
/// match layout {
///     Layout::BottomBanner => { /* ... */ },
///     Layout::Carousel => { /* ... */ },
///     Layout::MiddleBanner => { /* ... */ },
///     Layout::MobileFeed => { /* ... */ },
///     Layout::Overlays => { /* ... */ },
///     Layout::TopBanner => { /* ... */ },
///     other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
///     _ => { /* ... */ },
/// }
/// ```
/// The above code demonstrates that when `layout` represents
/// `NewFeature`, the execution path will lead to the second last match arm,
/// even though the enum does not contain a variant `Layout::NewFeature`
/// in the current version of SDK. The reason is that the variable `other`,
/// created by the `@` operator, is bound to
/// `Layout::Unknown(UnknownVariantValue("NewFeature".to_owned()))`
/// and calling `as_str` on it yields `"NewFeature"`.
/// This match expression is forward-compatible when executed with a newer
/// version of SDK where the variant `Layout::NewFeature` is defined.
/// Specifically, when `layout` represents `NewFeature`,
/// the execution path will hit the second last match arm as before by virtue of
/// calling `as_str` on `Layout::NewFeature` also yielding `"NewFeature"`.
///
/// Explicitly matching on the `Unknown` variant should
/// be avoided for two reasons:
/// - The inner data `UnknownVariantValue` is opaque, and no further information can be extracted.
/// - It might inadvertently shadow other intended match arms.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
    ::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
)]
pub enum Layout {
    #[allow(missing_docs)] // documentation missing in model
    BottomBanner,
    #[allow(missing_docs)] // documentation missing in model
    Carousel,
    #[allow(missing_docs)] // documentation missing in model
    MiddleBanner,
    #[allow(missing_docs)] // documentation missing in model
    MobileFeed,
    #[allow(missing_docs)] // documentation missing in model
    Overlays,
    #[allow(missing_docs)] // documentation missing in model
    TopBanner,
    /// `Unknown` contains new variants that have been added since this code was generated.
    Unknown(crate::primitives::UnknownVariantValue),
}
impl ::std::convert::From<&str> for Layout {
    fn from(s: &str) -> Self {
        match s {
            "BOTTOM_BANNER" => Layout::BottomBanner,
            "CAROUSEL" => Layout::Carousel,
            "MIDDLE_BANNER" => Layout::MiddleBanner,
            "MOBILE_FEED" => Layout::MobileFeed,
            "OVERLAYS" => Layout::Overlays,
            "TOP_BANNER" => Layout::TopBanner,
            other => Layout::Unknown(crate::primitives::UnknownVariantValue(other.to_owned())),
        }
    }
}
impl ::std::str::FromStr for Layout {
    type Err = ::std::convert::Infallible;

    fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
        ::std::result::Result::Ok(Layout::from(s))
    }
}
impl Layout {
    /// Returns the `&str` value of the enum member.
    pub fn as_str(&self) -> &str {
        match self {
            Layout::BottomBanner => "BOTTOM_BANNER",
            Layout::Carousel => "CAROUSEL",
            Layout::MiddleBanner => "MIDDLE_BANNER",
            Layout::MobileFeed => "MOBILE_FEED",
            Layout::Overlays => "OVERLAYS",
            Layout::TopBanner => "TOP_BANNER",
            Layout::Unknown(value) => value.as_str(),
        }
    }
    /// Returns all the `&str` representations of the enum members.
    pub const fn values() -> &'static [&'static str] {
        &["BOTTOM_BANNER", "CAROUSEL", "MIDDLE_BANNER", "MOBILE_FEED", "OVERLAYS", "TOP_BANNER"]
    }
}
impl ::std::convert::AsRef<str> for Layout {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}