Enum ConverseStreamOutput

#[non_exhaustive]
pub enum ConverseStreamOutput {
    ContentBlockDelta(ContentBlockDeltaEvent),
    ContentBlockStart(ContentBlockStartEvent),
    ContentBlockStop(ContentBlockStopEvent),
    MessageStart(MessageStartEvent),
    MessageStop(MessageStopEvent),
    Metadata(ConverseStreamMetadataEvent),
    #[non_exhaustive]
    Unknown,
}

The messages output stream

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.

ContentBlockDelta(ContentBlockDeltaEvent)

The messages output content block delta.

ContentBlockStart(ContentBlockStartEvent)

Start information for a content block.

ContentBlockStop(ContentBlockStopEvent)

Stop information for a content block.

MessageStart(MessageStartEvent)

Message start information.

MessageStop(MessageStopEvent)

Message stop information.

Metadata(ConverseStreamMetadataEvent)

Metadata for the converse output stream.

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 ConverseStreamOutput

pub fn as_content_block_delta(&self) -> Result<&ContentBlockDeltaEvent, &Self>

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

pub fn is_content_block_delta(&self) -> bool

Returns true if this is a ContentBlockDelta.

pub fn as_content_block_start(&self) -> Result<&ContentBlockStartEvent, &Self>

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

pub fn is_content_block_start(&self) -> bool

Returns true if this is a ContentBlockStart.

pub fn as_content_block_stop(&self) -> Result<&ContentBlockStopEvent, &Self>

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

pub fn is_content_block_stop(&self) -> bool

Returns true if this is a ContentBlockStop.

pub fn as_message_start(&self) -> Result<&MessageStartEvent, &Self>

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

pub fn is_message_start(&self) -> bool

Returns true if this is a MessageStart.

pub fn as_message_stop(&self) -> Result<&MessageStopEvent, &Self>

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

pub fn is_message_stop(&self) -> bool

Returns true if this is a MessageStop.

pub fn as_metadata(&self) -> Result<&ConverseStreamMetadataEvent, &Self>

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

pub fn is_metadata(&self) -> bool

Returns true if this is a Metadata.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ConverseStreamOutput

fn clone(&self) -> ConverseStreamOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConverseStreamOutput

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

Formats the value using the given formatter.

impl PartialEq for ConverseStreamOutput

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

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

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 ConverseStreamOutput