Skip to main content

GuardLayer

Struct GuardLayer 

Source
pub struct GuardLayer<G> { /* private fields */ }
Expand description

A tower Layer that applies a guard function before the inner service.

Guards run before the tool handler and can short-circuit with an error message. Use via ToolBuilderWithHandler::guard or Tool::with_guard rather than constructing directly.

§Example

use tower_mcp::{ToolBuilder, ToolRequest, CallToolResult};
use schemars::JsonSchema;
use serde::Deserialize;

#[derive(Debug, Deserialize, JsonSchema)]
struct DeleteInput { id: String, confirm: bool }

let tool = ToolBuilder::new("delete")
    .description("Delete a record")
    .handler(|input: DeleteInput| async move {
        Ok(CallToolResult::text(format!("deleted {}", input.id)))
    })
    .guard(|req: &ToolRequest| {
        let confirm = req.args.get("confirm").and_then(|v| v.as_bool()).unwrap_or(false);
        if !confirm {
            return Err("Must set confirm=true to delete".to_string());
        }
        Ok(())
    })
    .build();

Implementations§

Source§

impl<G> GuardLayer<G>

Source

pub fn new(guard: G) -> Self

Create a new guard layer from a closure.

The closure receives a &ToolRequest and returns Ok(()) to proceed or Err(String) to reject with an error message.

Trait Implementations§

Source§

impl<G: Clone> Clone for GuardLayer<G>

Source§

fn clone(&self) -> GuardLayer<G>

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<G, S> Layer<S> for GuardLayer<G>
where G: Clone,

Source§

type Service = GuardService<G, S>

The wrapped service
Source§

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

Auto Trait Implementations§

§

impl<G> Freeze for GuardLayer<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for GuardLayer<G>
where G: RefUnwindSafe,

§

impl<G> Send for GuardLayer<G>
where G: Send,

§

impl<G> Sync for GuardLayer<G>
where G: Sync,

§

impl<G> Unpin for GuardLayer<G>
where G: Unpin,

§

impl<G> UnwindSafe for GuardLayer<G>
where G: UnwindSafe,

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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<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