Skip to main content

BeforeToolCallResult

Enum BeforeToolCallResult 

Source
pub enum BeforeToolCallResult {
    Continue(Value),
    ShortCircuit(Value),
}
Expand description

Result from a before_tool_call hook invocation.

Determines whether tool execution continues with (possibly modified) arguments, or is short-circuited with a synthetic result.

§Examples

§Continuing with modified arguments

use adk_plugin::BeforeToolCallResult;
use serde_json::json;

// Pass through arguments unchanged
let args = json!({"query": "hello"});
let result = BeforeToolCallResult::Continue(args);

// Or modify arguments before passing to the tool
let sanitized = json!({"query": "hello", "safe_mode": true});
let result = BeforeToolCallResult::Continue(sanitized);

§Short-circuiting tool execution

use adk_plugin::BeforeToolCallResult;
use serde_json::json;

// Skip tool execution and return a cached result
let cached = json!({"data": "cached response"});
let result = BeforeToolCallResult::ShortCircuit(cached);

Variants§

§

Continue(Value)

Continue execution with (possibly modified) arguments.

The contained value will be passed to the next plugin in the chain, and ultimately to the tool execution if this is the last plugin.

§

ShortCircuit(Value)

Short-circuit: skip tool execution and use this synthetic result.

When returned, no further plugins in the chain are invoked, the tool is not executed, and this value is used as the tool output.

Trait Implementations§

Source§

impl Debug for BeforeToolCallResult

Source§

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

Formats the value using the given formatter. 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, 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> 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