Skip to main content

AgentSession

kranz_engine::backend

Trait AgentSession 

Source 
pub trait AgentSession: Send {
    // Required methods
    fn session_id(&self) -> String;
    fn next_event<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<Option<AgentEvent>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn send_user_message<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        text: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn abort<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn exit_status(&self) -> Option<SessionExit>;
}
Expand description

A live agent session. Consumers poll next_event until None, then call exit_status.

Required Methods§

Source

fn session_id(&self) -> String

The session id actually in use (== spec.session_id unless resumed).

Source

fn next_event<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<AgentEvent>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Next event from the session stream; None when the stream is closed.

Source

fn send_user_message<'life0, 'life1, 'async_trait>( &'life0 mut self, text: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Inject a user message (streaming-input sessions only; error otherwise).

Source

fn abort<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Terminate the underlying process/stream. Must kill the whole process tree and work on Windows (no bare POSIX signal assumptions — §9).

Source

fn exit_status(&self) -> Option<SessionExit>

Available after the stream has closed.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§