Skip to main content

ToolCallBuffer

Struct ToolCallBuffer 

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

Streaming buffer that accumulates tokens and detects tool call boundaries.

Use this in streaming response handlers to buffer tokens when a tool call prefix is detected, then parse and emit Part::FunctionCall when the closing tag arrives.

§Example

ⓘ
let mut buffer = ToolCallBuffer::new();

for chunk in stream {
    match buffer.push(&chunk.text) {
        BufferAction::Emit(parts) => {
            for part in parts { yield part; }
        }
        BufferAction::Buffering => { /* still accumulating */ }
    }
}
// Flush any remaining content at end of stream
for part in buffer.flush() { yield part; }

Implementations§

Source§

impl ToolCallBuffer

Source

pub fn new() -> Self

Create a new empty buffer that accepts a parsed call to any tool name.

Source

pub fn for_declared_tools(declared_tools: HashSet<String>) -> Self

Create a buffer that emits a parsed call only when every call names one of declared_tools, as parse_declared_tool_calls does.

With no declared tools the buffer never holds text back: every chunk is emitted as text immediately.

§Example
use std::collections::HashSet;

use adk_core::Part;
use adk_model::tool_call_parser::{BufferAction, ToolCallBuffer};

let mut buffer = ToolCallBuffer::for_declared_tools(HashSet::new());
let BufferAction::Emit(parts) = buffer.push("<tool_call>{\"name\":\"x\"}</tool_call>") else {
    panic!("nothing is buffered without declared tools");
};
assert!(matches!(&parts[0], Part::Text { .. }));
Source

pub fn push(&mut self, text: &str) -> BufferAction

Push a text chunk into the buffer.

Returns BufferAction::Emit with parts to yield, or BufferAction::Buffering if we’re accumulating a potential tool call.

Source

pub fn flush(&mut self) -> Vec<Part>

Flush any remaining buffered content as parts. Call this when the stream ends.

Trait Implementations§

Source§

impl Default for ToolCallBuffer

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, 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<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