Enum StartConversationRequestEventStream

#[non_exhaustive]
pub enum StartConversationRequestEventStream {
    AudioInputEvent(AudioInputEvent),
    ConfigurationEvent(ConfigurationEvent),
    DisconnectionEvent(DisconnectionEvent),
    DtmfInputEvent(DtmfInputEvent),
    PlaybackCompletionEvent(PlaybackCompletionEvent),
    TextInputEvent(TextInputEvent),
    #[non_exhaustive]
    Unknown,
}

Represents a stream of events between your application and Amazon Lex V2.

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.

AudioInputEvent(AudioInputEvent)

Speech audio sent from your client application to Amazon Lex V2. Audio starts accumulating when Amazon Lex V2 identifies a voice and continues until a natural pause in the speech is found before processing.

ConfigurationEvent(ConfigurationEvent)

Configuration information sent from your client application to Amazon Lex V2

DisconnectionEvent(DisconnectionEvent)

Event sent from the client application to indicate to Amazon Lex V2 that the conversation is over.

DtmfInputEvent(DtmfInputEvent)

DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 accumulates the DMTF information from when the user sends the first character and ends

• when there's a pause longer that the value configured for the end timeout.

• when there's a digit that is the configured end character.

• when Amazon Lex V2 accumulates characters equal to the maximum DTMF character configuration.

PlaybackCompletionEvent(PlaybackCompletionEvent)

Event sent from the client application to Amazon Lex V2 to indicate that it has finished playing audio and that Amazon Lex V2 should start listening for user input.

TextInputEvent(TextInputEvent)

Text sent from your client application to Amazon Lex V2. Each TextInputEvent is processed individually.

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl StartConversationRequestEventStream

pub fn as_audio_input_event(&self) -> Result<&AudioInputEvent, &Self>

Tries to convert the enum instance into AudioInputEvent, extracting the inner AudioInputEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_audio_input_event(&self) -> bool

Returns true if this is a AudioInputEvent.

pub fn as_configuration_event(&self) -> Result<&ConfigurationEvent, &Self>

Tries to convert the enum instance into ConfigurationEvent, extracting the inner ConfigurationEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_configuration_event(&self) -> bool

Returns true if this is a ConfigurationEvent.

pub fn as_disconnection_event(&self) -> Result<&DisconnectionEvent, &Self>

Tries to convert the enum instance into DisconnectionEvent, extracting the inner DisconnectionEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_disconnection_event(&self) -> bool

Returns true if this is a DisconnectionEvent.

pub fn as_dtmf_input_event(&self) -> Result<&DtmfInputEvent, &Self>

Tries to convert the enum instance into DtmfInputEvent, extracting the inner DtmfInputEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_dtmf_input_event(&self) -> bool

Returns true if this is a DtmfInputEvent.

pub fn as_playback_completion_event( &self, ) -> Result<&PlaybackCompletionEvent, &Self>

Tries to convert the enum instance into PlaybackCompletionEvent, extracting the inner PlaybackCompletionEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_playback_completion_event(&self) -> bool

Returns true if this is a PlaybackCompletionEvent.

pub fn as_text_input_event(&self) -> Result<&TextInputEvent, &Self>

Tries to convert the enum instance into TextInputEvent, extracting the inner TextInputEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_text_input_event(&self) -> bool

Returns true if this is a TextInputEvent.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for StartConversationRequestEventStream

fn clone(&self) -> StartConversationRequestEventStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartConversationRequestEventStream

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

Formats the value using the given formatter.

impl PartialEq for StartConversationRequestEventStream

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartConversationRequestEventStream