Skip to main content

EventStream

Struct EventStream 

Source
pub struct EventStream { /* private fields */ }
Expand description

Event stream with broadcast capability for real-time subscribers

Implementations§

Source§

impl EventStream

Source

pub fn new() -> Self

Create a new event stream with specified channel capacity

Source

pub fn with_capacity(capacity: usize) -> Self

Create event stream with custom channel capacity

Source

pub fn append( &self, scope: EventScope, event_type: EventType, component_id: String, status: ComponentStatus, workflow_id: WorkflowId, message: Option<String>, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Append a new event and broadcast to all subscribers

Events are emitted asynchronously in a spawned task to avoid blocking agent execution. Returns a JoinHandle that can be awaited if the caller needs to ensure the event was processed or needs the Event object.

§Examples
use agent_runtime::event::{EventStream, EventScope, EventType, ComponentStatus};
use serde_json::json;

let stream = EventStream::new();

// Fire and forget (most common)
stream.append(
    EventScope::Agent,
    EventType::Started,
    "my_agent".to_string(),
    ComponentStatus::Running,
    "workflow_1".to_string(),
    None,
    json!({})
);

// Wait for event if needed
let event = stream.append(
    EventScope::Agent,
    EventType::Completed,
    "my_agent".to_string(),
    ComponentStatus::Completed,
    "workflow_1".to_string(),
    Some("Agent completed successfully".to_string()),
    json!({})
).await.unwrap();
Source

pub fn append_with_parent( &self, scope: EventScope, event_type: EventType, component_id: String, status: ComponentStatus, workflow_id: WorkflowId, parent_workflow_id: Option<WorkflowId>, message: Option<String>, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Append event with optional parent workflow ID

Events are emitted asynchronously to avoid blocking execution. Returns a JoinHandle that resolves to the created Event.

Source

pub fn agent_started( &self, agent_name: &str, workflow_id: WorkflowId, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Agent::Started event

Source

pub fn agent_completed( &self, agent_name: &str, workflow_id: WorkflowId, message: Option<String>, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Agent::Completed event

Source

pub fn agent_failed( &self, agent_name: &str, workflow_id: WorkflowId, error: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Agent::Failed event

Source

pub fn llm_started( &self, agent_name: &str, iteration: usize, workflow_id: WorkflowId, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit LlmRequest::Started event

Source

pub fn llm_progress( &self, agent_name: &str, iteration: usize, workflow_id: WorkflowId, chunk: String, ) -> JoinHandle<Result<Event, String>>

Emit LlmRequest::Progress event (streaming chunk)

Source

pub fn llm_completed( &self, agent_name: &str, iteration: usize, workflow_id: WorkflowId, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit LlmRequest::Completed event

Source

pub fn llm_failed( &self, agent_name: &str, iteration: usize, workflow_id: WorkflowId, error: &str, ) -> JoinHandle<Result<Event, String>>

Emit LlmRequest::Failed event

Source

pub fn tool_started( &self, tool_name: &str, workflow_id: WorkflowId, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Tool::Started event

Source

pub fn tool_progress( &self, tool_name: &str, workflow_id: WorkflowId, message: &str, percent: Option<u8>, ) -> JoinHandle<Result<Event, String>>

Emit Tool::Progress event

Source

pub fn tool_completed( &self, tool_name: &str, workflow_id: WorkflowId, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Tool::Completed event

Source

pub fn tool_failed( &self, tool_name: &str, workflow_id: WorkflowId, error: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Tool::Failed event

Source

pub fn workflow_started( &self, workflow_name: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Workflow::Started event

Source

pub fn workflow_completed( &self, workflow_name: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Workflow::Completed event

Source

pub fn workflow_failed( &self, workflow_name: &str, error: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit Workflow::Failed event

Source

pub fn step_started( &self, workflow_name: &str, step_index: usize, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit WorkflowStep::Started event

Source

pub fn step_completed( &self, workflow_name: &str, step_index: usize, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit WorkflowStep::Completed event

Source

pub fn step_failed( &self, workflow_name: &str, step_index: usize, error: &str, data: JsonValue, ) -> JoinHandle<Result<Event, String>>

Emit WorkflowStep::Failed event

Source

pub fn subscribe(&self) -> Receiver<Event>

Subscribe to real-time event stream Returns a receiver that will get all future events

Source

pub fn from_offset(&self, offset: EventOffset) -> Vec<Event>

Get events from a specific offset (for replay)

Source

pub fn all(&self) -> Vec<Event>

Get all events

Source

pub fn len(&self) -> usize

Get event count

Source

pub fn is_empty(&self) -> bool

Source

pub fn current_offset(&self) -> EventOffset

Get the current offset (next event will have this offset)

Trait Implementations§

Source§

impl Clone for EventStream

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for EventStream

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more