Struct ProviderStreamChunk 

pub struct ProviderStreamChunk {
    pub schema_version: u16,
    pub chunk_index: u32,
    pub delta: ProviderStreamDelta,
    pub is_terminal: bool,
    pub usage: Option<ProviderUsage>,
}

Carries provider stream chunk data across a host-port boundary. Constructing the value does not call the host; the port method that receives it documents any adapter, network, or storage effect.

Fields

schema_version: u16

Wire schema version used for compatibility checks.

chunk_index: u32

Chunk index used by this record or request.

delta: ProviderStreamDelta

Delta used by this record or request.

is_terminal: bool

Whether is terminal is enabled. Policy, validation, or routing code uses this flag to choose the explicit behavior.

usage: Option<ProviderUsage>

Optional usage value. When absent, callers should use the documented default or skip that optional behavior.

Implementations

impl ProviderStreamChunk

pub const SCHEMA_VERSION: u16 = 1

Constant value for the ports::provider contract. Use it to keep SDK records and tests aligned on the same stable value.

pub fn text(chunk_index: u32, text: impl Into<String>) -> Self

Builds the text value. This is data construction and performs no I/O, journal append, event publication, or process work.

pub fn final_text( text: impl Into<String>, stop_reason: ProviderStopReason, usage: Option<ProviderUsage>, ) -> Self

Builds the final text value. This is data construction and performs no I/O, journal append, event publication, or process work.

Trait Implementations

impl Clone for ProviderStreamChunk

fn clone(&self) -> ProviderStreamChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderStreamChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderStreamChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderStreamChunk

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

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 ProviderStreamChunk

impl StructuralPartialEq for ProviderStreamChunk