Enum aws_sdk_cloudformation::model::Visibility

#[non_exhaustive]
pub enum Visibility {
    Private,
    Public,
    Unknown(UnknownVariantValue),
}

When writing a match expression against Visibility, 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:

# let visibility = unimplemented!();
match visibility {
    Visibility::Private => { /* ... */ },
    Visibility::Public => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when visibility represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant Visibility::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to Visibility::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 Visibility::NewFeature is defined. Specifically, when visibility represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on Visibility::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.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Private

Public

Unknown(UnknownVariantValue)

Unknown contains new variants that have been added since this code was generated.

Implementations

impl Visibility

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 3240)

    fn as_ref(&self) -> &str {
        self.as_str()
    }

src/operation_ser.rs (line 1748)

pub fn serialize_operation_crate_operation_list_types(
    input: &crate::input::ListTypesInput,
) -> Result<aws_smithy_http::body::SdkBody, aws_smithy_http::operation::error::SerializationError> {
    let mut out = String::new();
    #[allow(unused_mut)]
    let mut writer = aws_smithy_query::QueryWriter::new(&mut out, "ListTypes", "2010-05-15");
    #[allow(unused_mut)]
    let mut scope_491 = writer.prefix("Visibility");
    if let Some(var_492) = &input.visibility {
        scope_491.string(var_492.as_str());
    }
    #[allow(unused_mut)]
    let mut scope_493 = writer.prefix("ProvisioningType");
    if let Some(var_494) = &input.provisioning_type {
        scope_493.string(var_494.as_str());
    }
    #[allow(unused_mut)]
    let mut scope_495 = writer.prefix("DeprecatedStatus");
    if let Some(var_496) = &input.deprecated_status {
        scope_495.string(var_496.as_str());
    }
    #[allow(unused_mut)]
    let mut scope_497 = writer.prefix("Type");
    if let Some(var_498) = &input.r#type {
        scope_497.string(var_498.as_str());
    }
    #[allow(unused_mut)]
    let mut scope_499 = writer.prefix("Filters");
    if let Some(var_500) = &input.filters {
        crate::query_ser::serialize_structure_crate_model_type_filters(scope_499, var_500)?;
    }
    #[allow(unused_mut)]
    let mut scope_501 = writer.prefix("MaxResults");
    if let Some(var_502) = &input.max_results {
        scope_501.number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_502).into()),
        );
    }
    #[allow(unused_mut)]
    let mut scope_503 = writer.prefix("NextToken");
    if let Some(var_504) = &input.next_token {
        scope_503.string(var_504);
    }
    writer.finish();
    Ok(aws_smithy_http::body::SdkBody::from(out))
}

pub const fn values() -> &'static [&'static str]

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for Visibility

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Visibility

fn clone(&self) -> Visibility

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Visibility

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for Visibility

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for Visibility

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Visibility

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Visibility

fn cmp(&self, other: &Visibility) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Visibility> for Visibility

fn eq(&self, other: &Visibility) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Visibility> for Visibility

fn partial_cmp(&self, other: &Visibility) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Visibility

impl StructuralEq for Visibility

impl StructuralPartialEq for Visibility