Enum aws_sdk_transcribe::model::VocabularyFilterMethod

#[non_exhaustive]
pub enum VocabularyFilterMethod {
    Mask,
    Remove,
    Tag,
    Unknown(UnknownVariantValue),
}

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

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

Mask

Remove

Tag

Unknown(UnknownVariantValue)

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

Implementations

impl VocabularyFilterMethod

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 3753)

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

src/json_ser.rs (line 998)

pub fn serialize_structure_crate_model_call_analytics_job_settings(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::CallAnalyticsJobSettings,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_198) = &input.vocabulary_name {
        object.key("VocabularyName").string(var_198.as_str());
    }
    if let Some(var_199) = &input.vocabulary_filter_name {
        object.key("VocabularyFilterName").string(var_199.as_str());
    }
    if let Some(var_200) = &input.vocabulary_filter_method {
        object
            .key("VocabularyFilterMethod")
            .string(var_200.as_str());
    }
    if let Some(var_201) = &input.language_model_name {
        object.key("LanguageModelName").string(var_201.as_str());
    }
    if let Some(var_202) = &input.content_redaction {
        #[allow(unused_mut)]
        let mut object_203 = object.key("ContentRedaction").start_object();
        crate::json_ser::serialize_structure_crate_model_content_redaction(
            &mut object_203,
            var_202,
        )?;
        object_203.finish();
    }
    if let Some(var_204) = &input.language_options {
        let mut array_205 = object.key("LanguageOptions").start_array();
        for item_206 in var_204 {
            {
                array_205.value().string(item_206.as_str());
            }
        }
        array_205.finish();
    }
    if let Some(var_207) = &input.language_id_settings {
        #[allow(unused_mut)]
        let mut object_208 = object.key("LanguageIdSettings").start_object();
        for (key_209, value_210) in var_207 {
            {
                #[allow(unused_mut)]
                let mut object_211 = object_208.key(key_209.as_str()).start_object();
                crate::json_ser::serialize_structure_crate_model_language_id_settings(
                    &mut object_211,
                    value_210,
                )?;
                object_211.finish();
            }
        }
        object_208.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_channel_definition(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::ChannelDefinition,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if input.channel_id != 0 {
        object.key("ChannelId").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((input.channel_id).into()),
        );
    }
    if let Some(var_212) = &input.participant_role {
        object.key("ParticipantRole").string(var_212.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_medical_transcription_setting(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::MedicalTranscriptionSetting,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_213) = &input.show_speaker_labels {
        object.key("ShowSpeakerLabels").boolean(*var_213);
    }
    if let Some(var_214) = &input.max_speaker_labels {
        object.key("MaxSpeakerLabels").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_214).into()),
        );
    }
    if let Some(var_215) = &input.channel_identification {
        object.key("ChannelIdentification").boolean(*var_215);
    }
    if let Some(var_216) = &input.show_alternatives {
        object.key("ShowAlternatives").boolean(*var_216);
    }
    if let Some(var_217) = &input.max_alternatives {
        object.key("MaxAlternatives").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_217).into()),
        );
    }
    if let Some(var_218) = &input.vocabulary_name {
        object.key("VocabularyName").string(var_218.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_settings(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::Settings,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_219) = &input.vocabulary_name {
        object.key("VocabularyName").string(var_219.as_str());
    }
    if let Some(var_220) = &input.show_speaker_labels {
        object.key("ShowSpeakerLabels").boolean(*var_220);
    }
    if let Some(var_221) = &input.max_speaker_labels {
        object.key("MaxSpeakerLabels").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_221).into()),
        );
    }
    if let Some(var_222) = &input.channel_identification {
        object.key("ChannelIdentification").boolean(*var_222);
    }
    if let Some(var_223) = &input.show_alternatives {
        object.key("ShowAlternatives").boolean(*var_223);
    }
    if let Some(var_224) = &input.max_alternatives {
        object.key("MaxAlternatives").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_224).into()),
        );
    }
    if let Some(var_225) = &input.vocabulary_filter_name {
        object.key("VocabularyFilterName").string(var_225.as_str());
    }
    if let Some(var_226) = &input.vocabulary_filter_method {
        object
            .key("VocabularyFilterMethod")
            .string(var_226.as_str());
    }
    Ok(())
}

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

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for VocabularyFilterMethod

fn as_ref(&self) -> &str

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

impl Clone for VocabularyFilterMethod

fn clone(&self) -> VocabularyFilterMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VocabularyFilterMethod

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

Formats the value using the given formatter.

impl From<&str> for VocabularyFilterMethod

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for VocabularyFilterMethod

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 VocabularyFilterMethod

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 VocabularyFilterMethod

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

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

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

impl StructuralEq for VocabularyFilterMethod

impl StructuralPartialEq for VocabularyFilterMethod