Enum StartConversationResponseEventStream

#[non_exhaustive]
pub enum StartConversationResponseEventStream {
    AudioResponseEvent(AudioResponseEvent),
    HeartbeatEvent(HeartbeatEvent),
    IntentResultEvent(IntentResultEvent),
    PlaybackInterruptionEvent(PlaybackInterruptionEvent),
    TextResponseEvent(TextResponseEvent),
    TranscriptEvent(TranscriptEvent),
    #[non_exhaustive]
    Unknown,
}

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

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.

AudioResponseEvent(AudioResponseEvent)

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

HeartbeatEvent(HeartbeatEvent)

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

IntentResultEvent(IntentResultEvent)

Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.

PlaybackInterruptionEvent(PlaybackInterruptionEvent)

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

TextResponseEvent(TextResponseEvent)

The event sent from Amazon Lex V2 to your application with text to present to the user.

TranscriptEvent(TranscriptEvent)

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

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 StartConversationResponseEventStream

pub fn as_audio_response_event(&self) -> Result<&AudioResponseEvent, &Self>

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

pub fn is_audio_response_event(&self) -> bool

Returns true if this is a AudioResponseEvent.

pub fn as_heartbeat_event(&self) -> Result<&HeartbeatEvent, &Self>

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

pub fn is_heartbeat_event(&self) -> bool

Returns true if this is a HeartbeatEvent.

pub fn as_intent_result_event(&self) -> Result<&IntentResultEvent, &Self>

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

pub fn is_intent_result_event(&self) -> bool

Returns true if this is a IntentResultEvent.

pub fn as_playback_interruption_event( &self, ) -> Result<&PlaybackInterruptionEvent, &Self>

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

pub fn is_playback_interruption_event(&self) -> bool

Returns true if this is a PlaybackInterruptionEvent.

pub fn as_text_response_event(&self) -> Result<&TextResponseEvent, &Self>

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

pub fn is_text_response_event(&self) -> bool

Returns true if this is a TextResponseEvent.

pub fn as_transcript_event(&self) -> Result<&TranscriptEvent, &Self>

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

pub fn is_transcript_event(&self) -> bool

Returns true if this is a TranscriptEvent.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for StartConversationResponseEventStream

fn clone(&self) -> StartConversationResponseEventStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartConversationResponseEventStream

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

Formats the value using the given formatter.

impl PartialEq for StartConversationResponseEventStream

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