Enum StreamChannel 

pub enum StreamChannel {
    AssistantText,
    ReasoningSummary,
    ProviderExposedReasoning,
    ToolCallArguments,
    ToolResultText,
    RealtimeTranscript,
    RealtimeMedia,
    HiddenChainOfThought,
}

Enumerates the finite stream channel cases. Serialized names are part of the SDK contract; update fixtures when variants change.

Variants

AssistantText

Use this variant when the contract needs to represent assistant text; selecting it has no side effect by itself.

ReasoningSummary

Use this variant when the contract needs to represent reasoning summary; selecting it has no side effect by itself.

ProviderExposedReasoning

Use this variant when the contract needs to represent provider exposed reasoning; selecting it has no side effect by itself.

ToolCallArguments

Use this variant when the contract needs to represent tool call arguments; selecting it has no side effect by itself.

ToolResultText

Use this variant when the contract needs to represent tool result text; selecting it has no side effect by itself.

RealtimeTranscript

Use this variant when the contract needs to represent realtime transcript; selecting it has no side effect by itself.

RealtimeMedia

Use this variant when the contract needs to represent realtime media; selecting it has no side effect by itself.

HiddenChainOfThought

Use this variant when the contract needs to represent hidden chain of thought; selecting it has no side effect by itself.

Implementations

impl StreamChannel

pub fn is_policy_visible(&self) -> bool

Reports whether this value is policy visible. The check is pure and does not mutate SDK or host state.

pub fn as_contract_name(&self) -> &'static str

Returns this value as contract name. The accessor is side-effect free and keeps ownership with the caller.

Trait Implementations

impl Clone for StreamChannel

fn clone(&self) -> StreamChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamChannel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamChannel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StreamChannel

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 StreamChannel

fn cmp(&self, other: &StreamChannel) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StreamChannel

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

fn partial_cmp(&self, other: &StreamChannel) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StreamChannel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StreamChannel

impl StructuralPartialEq for StreamChannel