Enum aws_sdk_directconnect::model::AddressFamily

#[non_exhaustive]
pub enum AddressFamily {
    IPv4,
    IPv6,
    Unknown(UnknownVariantValue),
}

When writing a match expression against AddressFamily, 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 addressfamily = unimplemented!();
match addressfamily {
    AddressFamily::IPv4 => { /* ... */ },
    AddressFamily::IPv6 => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

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

IPv4

IPv6

Unknown(UnknownVariantValue)

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

Implementations

impl AddressFamily

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 644)

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

src/json_ser.rs (line 1246)

pub fn serialize_structure_crate_model_new_private_virtual_interface_allocation(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewPrivateVirtualInterfaceAllocation,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_217) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_217.as_str());
    }
    {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_218) = &input.mtu {
        object.key("mtu").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_218).into()),
        );
    }
    if let Some(var_219) = &input.auth_key {
        object.key("authKey").string(var_219.as_str());
    }
    if let Some(var_220) = &input.amazon_address {
        object.key("amazonAddress").string(var_220.as_str());
    }
    if let Some(var_221) = &input.address_family {
        object.key("addressFamily").string(var_221.as_str());
    }
    if let Some(var_222) = &input.customer_address {
        object.key("customerAddress").string(var_222.as_str());
    }
    if let Some(var_223) = &input.tags {
        let mut array_224 = object.key("tags").start_array();
        for item_225 in var_223 {
            {
                #[allow(unused_mut)]
                let mut object_226 = array_224.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_226, item_225)?;
                object_226.finish();
            }
        }
        array_224.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_public_virtual_interface_allocation(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewPublicVirtualInterfaceAllocation,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_227) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_227.as_str());
    }
    {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_228) = &input.auth_key {
        object.key("authKey").string(var_228.as_str());
    }
    if let Some(var_229) = &input.amazon_address {
        object.key("amazonAddress").string(var_229.as_str());
    }
    if let Some(var_230) = &input.customer_address {
        object.key("customerAddress").string(var_230.as_str());
    }
    if let Some(var_231) = &input.address_family {
        object.key("addressFamily").string(var_231.as_str());
    }
    if let Some(var_232) = &input.route_filter_prefixes {
        let mut array_233 = object.key("routeFilterPrefixes").start_array();
        for item_234 in var_232 {
            {
                #[allow(unused_mut)]
                let mut object_235 = array_233.value().start_object();
                crate::json_ser::serialize_structure_crate_model_route_filter_prefix(
                    &mut object_235,
                    item_234,
                )?;
                object_235.finish();
            }
        }
        array_233.finish();
    }
    if let Some(var_236) = &input.tags {
        let mut array_237 = object.key("tags").start_array();
        for item_238 in var_236 {
            {
                #[allow(unused_mut)]
                let mut object_239 = array_237.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_239, item_238)?;
                object_239.finish();
            }
        }
        array_237.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_transit_virtual_interface_allocation(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewTransitVirtualInterfaceAllocation,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_240) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_240.as_str());
    }
    if input.vlan != 0 {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    if input.asn != 0 {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_241) = &input.mtu {
        object.key("mtu").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_241).into()),
        );
    }
    if let Some(var_242) = &input.auth_key {
        object.key("authKey").string(var_242.as_str());
    }
    if let Some(var_243) = &input.amazon_address {
        object.key("amazonAddress").string(var_243.as_str());
    }
    if let Some(var_244) = &input.customer_address {
        object.key("customerAddress").string(var_244.as_str());
    }
    if let Some(var_245) = &input.address_family {
        object.key("addressFamily").string(var_245.as_str());
    }
    if let Some(var_246) = &input.tags {
        let mut array_247 = object.key("tags").start_array();
        for item_248 in var_246 {
            {
                #[allow(unused_mut)]
                let mut object_249 = array_247.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_249, item_248)?;
                object_249.finish();
            }
        }
        array_247.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_bgp_peer(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewBgpPeer,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if input.asn != 0 {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_250) = &input.auth_key {
        object.key("authKey").string(var_250.as_str());
    }
    if let Some(var_251) = &input.address_family {
        object.key("addressFamily").string(var_251.as_str());
    }
    if let Some(var_252) = &input.amazon_address {
        object.key("amazonAddress").string(var_252.as_str());
    }
    if let Some(var_253) = &input.customer_address {
        object.key("customerAddress").string(var_253.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_private_virtual_interface(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewPrivateVirtualInterface,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_254) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_254.as_str());
    }
    {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_255) = &input.mtu {
        object.key("mtu").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_255).into()),
        );
    }
    if let Some(var_256) = &input.auth_key {
        object.key("authKey").string(var_256.as_str());
    }
    if let Some(var_257) = &input.amazon_address {
        object.key("amazonAddress").string(var_257.as_str());
    }
    if let Some(var_258) = &input.customer_address {
        object.key("customerAddress").string(var_258.as_str());
    }
    if let Some(var_259) = &input.address_family {
        object.key("addressFamily").string(var_259.as_str());
    }
    if let Some(var_260) = &input.virtual_gateway_id {
        object.key("virtualGatewayId").string(var_260.as_str());
    }
    if let Some(var_261) = &input.direct_connect_gateway_id {
        object
            .key("directConnectGatewayId")
            .string(var_261.as_str());
    }
    if let Some(var_262) = &input.tags {
        let mut array_263 = object.key("tags").start_array();
        for item_264 in var_262 {
            {
                #[allow(unused_mut)]
                let mut object_265 = array_263.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_265, item_264)?;
                object_265.finish();
            }
        }
        array_263.finish();
    }
    if let Some(var_266) = &input.enable_site_link {
        object.key("enableSiteLink").boolean(*var_266);
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_public_virtual_interface(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewPublicVirtualInterface,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_267) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_267.as_str());
    }
    {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_268) = &input.auth_key {
        object.key("authKey").string(var_268.as_str());
    }
    if let Some(var_269) = &input.amazon_address {
        object.key("amazonAddress").string(var_269.as_str());
    }
    if let Some(var_270) = &input.customer_address {
        object.key("customerAddress").string(var_270.as_str());
    }
    if let Some(var_271) = &input.address_family {
        object.key("addressFamily").string(var_271.as_str());
    }
    if let Some(var_272) = &input.route_filter_prefixes {
        let mut array_273 = object.key("routeFilterPrefixes").start_array();
        for item_274 in var_272 {
            {
                #[allow(unused_mut)]
                let mut object_275 = array_273.value().start_object();
                crate::json_ser::serialize_structure_crate_model_route_filter_prefix(
                    &mut object_275,
                    item_274,
                )?;
                object_275.finish();
            }
        }
        array_273.finish();
    }
    if let Some(var_276) = &input.tags {
        let mut array_277 = object.key("tags").start_array();
        for item_278 in var_276 {
            {
                #[allow(unused_mut)]
                let mut object_279 = array_277.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_279, item_278)?;
                object_279.finish();
            }
        }
        array_277.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_new_transit_virtual_interface(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NewTransitVirtualInterface,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_280) = &input.virtual_interface_name {
        object.key("virtualInterfaceName").string(var_280.as_str());
    }
    if input.vlan != 0 {
        object.key("vlan").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.vlan).into()),
        );
    }
    if input.asn != 0 {
        object.key("asn").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.asn).into()),
        );
    }
    if let Some(var_281) = &input.mtu {
        object.key("mtu").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_281).into()),
        );
    }
    if let Some(var_282) = &input.auth_key {
        object.key("authKey").string(var_282.as_str());
    }
    if let Some(var_283) = &input.amazon_address {
        object.key("amazonAddress").string(var_283.as_str());
    }
    if let Some(var_284) = &input.customer_address {
        object.key("customerAddress").string(var_284.as_str());
    }
    if let Some(var_285) = &input.address_family {
        object.key("addressFamily").string(var_285.as_str());
    }
    if let Some(var_286) = &input.direct_connect_gateway_id {
        object
            .key("directConnectGatewayId")
            .string(var_286.as_str());
    }
    if let Some(var_287) = &input.tags {
        let mut array_288 = object.key("tags").start_array();
        for item_289 in var_287 {
            {
                #[allow(unused_mut)]
                let mut object_290 = array_288.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_290, item_289)?;
                object_290.finish();
            }
        }
        array_288.finish();
    }
    if let Some(var_291) = &input.enable_site_link {
        object.key("enableSiteLink").boolean(*var_291);
    }
    Ok(())
}

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

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for AddressFamily

fn as_ref(&self) -> &str

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

impl Clone for AddressFamily

fn clone(&self) -> AddressFamily

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressFamily

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

Formats the value using the given formatter.

impl From<&str> for AddressFamily

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for AddressFamily

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 AddressFamily

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 AddressFamily

fn cmp(&self, other: &AddressFamily) -> 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<AddressFamily> for AddressFamily

fn eq(&self, other: &AddressFamily) -> 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<AddressFamily> for AddressFamily

fn partial_cmp(&self, other: &AddressFamily) -> 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 AddressFamily

impl StructuralEq for AddressFamily

impl StructuralPartialEq for AddressFamily