Skip to main content

ServiceRealtimeAdapter

Struct ServiceRealtimeAdapter 

Source
pub struct ServiceRealtimeAdapter<S: RealtimeLlmService> { /* private fields */ }
Expand description

Adapts any RealtimeLlmService connector into the pipeline’s RealtimeLlm + RealtimeKickoff surface. See the module docs.

Implementations§

Source§

impl<S: RealtimeLlmService> ServiceRealtimeAdapter<S>

Source

pub fn new(inner: S) -> Self

Wrap a realtime connector.

Source

pub fn into_inner(self) -> S

Unwrap back to the underlying connector.

Trait Implementations§

Source§

impl<S: RealtimeLlmService> RealtimeKickoff for ServiceRealtimeAdapter<S>

Source§

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

Trigger an initial model turn so the bot speaks first.
Source§

impl<S: RealtimeLlmService> RealtimeLlm for ServiceRealtimeAdapter<S>

Source§

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

Open the session with the initial system prompt + tools + audio rates.
Source§

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

Stream a chunk of caller audio (16 kHz PCM) to the model.
Source§

fn update_system<'life0, 'async_trait>( &'life0 mut self, prompt: String, tools: Vec<ToolDecl>, ) -> Pin<Box<dyn Future<Output = Result<(), FlowcatError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Replace the active system prompt and tool set (on a brain transition).
Source§

fn send_tool_result<'life0, 'async_trait>( &'life0 mut self, id: String, result: Value, ) -> Pin<Box<dyn Future<Output = Result<(), FlowcatError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Return the result of a tool/function call back to the model.
Source§

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

Await the next model event, or None when the session has closed.
Source§

fn input_sample_rate(&self) -> u32

The PCM sample rate (Hz) the model expects on its audio input. The s2s pipeline resamples caller audio to this before send_audio and advertises it to the model in RealtimeSetup::input_sample_rate. Default 16 kHz (Gemini Live); a provider that requires a different input rate (OpenAI Realtime needs ≥ 24 kHz) overrides this.
Source§

fn event_notify(&self) -> Option<Arc<Notify>>

A Notify that fires whenever a model event becomes available, so a consumer can await readiness WITHOUT holding this session’s lock across next_event (which would starve send_audio). None (the default) means the provider doesn’t support the non-blocking path and the consumer falls back to the blocking next_event. GeminiLive returns Some.
Source§

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

Non-blocking sibling of next_event: return the next event if one is immediately ready, else PollEvent::Pending (the caller should event_notify().notified().await — lock released — then re-poll). The default blocks (legacy behaviour); providers that return a real event_notify MUST override this to be genuinely non-blocking.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> RealtimeBackend for T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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