Enum aws_sdk_transcribe::model::ParticipantRole

#[non_exhaustive]
pub enum ParticipantRole {
    Agent,
    Customer,
    Unknown(UnknownVariantValue),
}

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

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

Agent

Customer

Unknown(UnknownVariantValue)

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

Implementations

impl ParticipantRole

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 828)

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

src/json_ser.rs (line 1051)

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 fn serialize_structure_crate_model_model_settings(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::ModelSettings,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_227) = &input.language_model_name {
        object.key("LanguageModelName").string(var_227.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_job_execution_settings(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::JobExecutionSettings,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_228) = &input.allow_deferred_execution {
        object.key("AllowDeferredExecution").boolean(*var_228);
    }
    if let Some(var_229) = &input.data_access_role_arn {
        object.key("DataAccessRoleArn").string(var_229.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_content_redaction(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::ContentRedaction,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_230) = &input.redaction_type {
        object.key("RedactionType").string(var_230.as_str());
    }
    if let Some(var_231) = &input.redaction_output {
        object.key("RedactionOutput").string(var_231.as_str());
    }
    if let Some(var_232) = &input.pii_entity_types {
        let mut array_233 = object.key("PiiEntityTypes").start_array();
        for item_234 in var_232 {
            {
                array_233.value().string(item_234.as_str());
            }
        }
        array_233.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_subtitles(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::Subtitles,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_235) = &input.formats {
        let mut array_236 = object.key("Formats").start_array();
        for item_237 in var_235 {
            {
                array_236.value().string(item_237.as_str());
            }
        }
        array_236.finish();
    }
    if let Some(var_238) = &input.output_start_index {
        object.key("OutputStartIndex").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_238).into()),
        );
    }
    Ok(())
}

pub fn serialize_structure_crate_model_language_id_settings(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::LanguageIdSettings,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_239) = &input.vocabulary_name {
        object.key("VocabularyName").string(var_239.as_str());
    }
    if let Some(var_240) = &input.vocabulary_filter_name {
        object.key("VocabularyFilterName").string(var_240.as_str());
    }
    if let Some(var_241) = &input.language_model_name {
        object.key("LanguageModelName").string(var_241.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_non_talk_time_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NonTalkTimeFilter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_242) = &input.threshold {
        object.key("Threshold").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_242).into()),
        );
    }
    if let Some(var_243) = &input.absolute_time_range {
        #[allow(unused_mut)]
        let mut object_244 = object.key("AbsoluteTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_absolute_time_range(
            &mut object_244,
            var_243,
        )?;
        object_244.finish();
    }
    if let Some(var_245) = &input.relative_time_range {
        #[allow(unused_mut)]
        let mut object_246 = object.key("RelativeTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_relative_time_range(
            &mut object_246,
            var_245,
        )?;
        object_246.finish();
    }
    if let Some(var_247) = &input.negate {
        object.key("Negate").boolean(*var_247);
    }
    Ok(())
}

pub fn serialize_structure_crate_model_interruption_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::InterruptionFilter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_248) = &input.threshold {
        object.key("Threshold").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_248).into()),
        );
    }
    if let Some(var_249) = &input.participant_role {
        object.key("ParticipantRole").string(var_249.as_str());
    }
    if let Some(var_250) = &input.absolute_time_range {
        #[allow(unused_mut)]
        let mut object_251 = object.key("AbsoluteTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_absolute_time_range(
            &mut object_251,
            var_250,
        )?;
        object_251.finish();
    }
    if let Some(var_252) = &input.relative_time_range {
        #[allow(unused_mut)]
        let mut object_253 = object.key("RelativeTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_relative_time_range(
            &mut object_253,
            var_252,
        )?;
        object_253.finish();
    }
    if let Some(var_254) = &input.negate {
        object.key("Negate").boolean(*var_254);
    }
    Ok(())
}

pub fn serialize_structure_crate_model_transcript_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::TranscriptFilter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_255) = &input.transcript_filter_type {
        object.key("TranscriptFilterType").string(var_255.as_str());
    }
    if let Some(var_256) = &input.absolute_time_range {
        #[allow(unused_mut)]
        let mut object_257 = object.key("AbsoluteTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_absolute_time_range(
            &mut object_257,
            var_256,
        )?;
        object_257.finish();
    }
    if let Some(var_258) = &input.relative_time_range {
        #[allow(unused_mut)]
        let mut object_259 = object.key("RelativeTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_relative_time_range(
            &mut object_259,
            var_258,
        )?;
        object_259.finish();
    }
    if let Some(var_260) = &input.participant_role {
        object.key("ParticipantRole").string(var_260.as_str());
    }
    if let Some(var_261) = &input.negate {
        object.key("Negate").boolean(*var_261);
    }
    if let Some(var_262) = &input.targets {
        let mut array_263 = object.key("Targets").start_array();
        for item_264 in var_262 {
            {
                array_263.value().string(item_264.as_str());
            }
        }
        array_263.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_sentiment_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::SentimentFilter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_265) = &input.sentiments {
        let mut array_266 = object.key("Sentiments").start_array();
        for item_267 in var_265 {
            {
                array_266.value().string(item_267.as_str());
            }
        }
        array_266.finish();
    }
    if let Some(var_268) = &input.absolute_time_range {
        #[allow(unused_mut)]
        let mut object_269 = object.key("AbsoluteTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_absolute_time_range(
            &mut object_269,
            var_268,
        )?;
        object_269.finish();
    }
    if let Some(var_270) = &input.relative_time_range {
        #[allow(unused_mut)]
        let mut object_271 = object.key("RelativeTimeRange").start_object();
        crate::json_ser::serialize_structure_crate_model_relative_time_range(
            &mut object_271,
            var_270,
        )?;
        object_271.finish();
    }
    if let Some(var_272) = &input.participant_role {
        object.key("ParticipantRole").string(var_272.as_str());
    }
    if let Some(var_273) = &input.negate {
        object.key("Negate").boolean(*var_273);
    }
    Ok(())
}

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

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for ParticipantRole

fn as_ref(&self) -> &str

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

impl Clone for ParticipantRole

fn clone(&self) -> ParticipantRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParticipantRole

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

Formats the value using the given formatter.

impl From<&str> for ParticipantRole

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for ParticipantRole

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 ParticipantRole

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 ParticipantRole

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

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

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

impl StructuralEq for ParticipantRole

impl StructuralPartialEq for ParticipantRole