Skip to main content

StreamDelta

Struct StreamDelta 

Source
pub struct StreamDelta {
Show 20 fields pub delta_id: StreamDeltaId, pub run_id: RunId, pub agent_id: AgentId, pub turn_id: Option<TurnId>, pub attempt_id: Option<AttemptId>, pub message_id: Option<MessageId>, pub tool_call_id: Option<ToolCallId>, pub realtime_session_id: Option<RealtimeSessionId>, pub channel: StreamChannel, pub direction: Option<StreamDirection>, pub cursor: StreamCursor, pub source: SourceRef, pub destination: Option<DestinationRef>, pub policy_refs: Vec<PolicyRef>, pub privacy: PrivacyClass, pub retention: RetentionClass, pub content_ref: Option<ContentRef>, pub marker_id: Option<MarkerId>, pub redacted_summary: String, pub runtime_package_fingerprint: String, /* private fields */
}
Expand description

Carries the stream delta record payload for journal, event, or fixture surfaces. Creating or cloning it only preserves serialized SDK state; append, publish, replay, or export effects are documented on the runtime and port methods that store it.

Fields§

§delta_id: StreamDeltaId

Stable delta id used for typed lineage, lookup, or dedupe.

§run_id: RunId

Run identifier used for lineage, filtering, replay, and dedupe.

§agent_id: AgentId

Agent identifier used for lineage, filtering, and ownership checks.

§turn_id: Option<TurnId>

Turn identifier for one loop turn within a run.

§attempt_id: Option<AttemptId>

Attempt identifier for retry, repair, provider, or tool execution evidence.

§message_id: Option<MessageId>

Message identifier for transcript, projection, or provider-response lineage.

§tool_call_id: Option<ToolCallId>

Stable tool call id used for typed lineage, lookup, or dedupe.

§realtime_session_id: Option<RealtimeSessionId>

Stable realtime session id used for typed lineage, lookup, or dedupe.

§channel: StreamChannel

Channel used by this record or request.

§direction: Option<StreamDirection>

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

§cursor: StreamCursor

Cursor identifying a replay, export, or subscription position. Use it to resume without widening the original scope.

§source: SourceRef

Source label or ref for this item; it is metadata and does not fetch content by itself.

§destination: Option<DestinationRef>

Destination label or ref for this item; it is metadata and does not deliver content by itself.

§policy_refs: Vec<PolicyRef>

Policy references that govern admission, projection, execution, or delivery.

§privacy: PrivacyClass

Privacy class used for projection, telemetry, and raw-content access decisions.

§retention: RetentionClass

Retention class used by hosts and sinks when storing or exporting this item.

§content_ref: Option<ContentRef>

Content reference where payload bytes or structured tool output are stored.

§marker_id: Option<MarkerId>

Stable marker id used for typed lineage, lookup, or dedupe.

§redacted_summary: String

Redacted human-readable summary safe for events, telemetry, and logs.

§runtime_package_fingerprint: String

Fingerprint of the runtime package snapshot in force when this value was produced. Use it for replay, dedupe, and package-lineage checks; the field is evidence and does not execute package behavior.

Implementations§

Source§

impl StreamDelta

Source

pub fn visible_text( delta_id: impl Into<String>, channel: StreamChannel, cursor: StreamCursor, text: impl Into<String>, source: SourceRef, ) -> Self

Builds the visible text value with the documented defaults. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn marker( delta_id: impl Into<String>, channel: StreamChannel, cursor: StreamCursor, marker_id: impl Into<String>, source: SourceRef, ) -> Self

Marker. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn with_run(self, run_id: RunId, agent_id: AgentId) -> Self

Returns this value with its run setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn with_turn(self, turn_id: TurnId) -> Self

Returns this value with its turn setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn with_attempt(self, attempt_id: AttemptId) -> Self

Returns this value with its attempt setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn with_direction(self, direction: StreamDirection) -> Self

Returns this value with its direction setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn with_destination(self, destination: DestinationRef) -> Self

Returns this value with its destination setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn with_content_ref(self, content_ref: ContentRef) -> Self

Returns this value with its content ref setting replaced. The method follows builder-style data construction and does not execute external work.

Source

pub fn matcher_text(&self) -> Option<&str>

Returns the matcher text currently held by this value. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Source

pub fn serialized_raw_text_absent(&self) -> bool

Returns whether serialized raw text absent applies for this contract. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.

Trait Implementations§

Source§

impl Clone for StreamDelta

Source§

fn clone(&self) -> StreamDelta

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamDelta

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for StreamDelta

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for StreamDelta

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for StreamDelta

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for StreamDelta

Source§

impl StructuralPartialEq for StreamDelta

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,