Trait ResourceHandler 

pub trait ResourceHandler: Send + Sync {
    // Required methods
    fn list_resources(
        &self,
        ctx: &Context<'_>,
    ) -> impl Future<Output = Result<Vec<Resource>, McpError>> + Send;
    fn read_resource(
        &self,
        uri: &str,
        ctx: &Context<'_>,
    ) -> impl Future<Output = Result<Vec<ResourceContents>, McpError>> + Send;

    // Provided methods
    fn list_resource_templates(
        &self,
        _ctx: &Context<'_>,
    ) -> impl Future<Output = Result<Vec<ResourceTemplate>, McpError>> + Send { ... }
    fn subscribe(
        &self,
        _uri: &str,
        _ctx: &Context<'_>,
    ) -> impl Future<Output = Result<bool, McpError>> + Send { ... }
    fn unsubscribe(
        &self,
        _uri: &str,
        _ctx: &Context<'_>,
    ) -> impl Future<Output = Result<bool, McpError>> + Send { ... }
}

Handler for resource-related operations.

Implement this trait to expose resources that AI assistants can read.

Required Methods

fn list_resources( &self, ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<Resource>, McpError>> + Send

List all available static resources.

This returns resources with fixed URIs. For dynamic resources with parameterized URIs (e.g., file://{path}), use list_resource_templates().

fn read_resource( &self, uri: &str, ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<ResourceContents>, McpError>> + Send

Read a resource by URI.

Provided Methods

fn list_resource_templates( &self, _ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<ResourceTemplate>, McpError>> + Send

List all available resource templates.

Resource templates describe dynamic resources with parameterized URIs. For example, a template with URI file://{path} allows clients to construct URIs like file:///etc/hosts to read specific files.

The default implementation returns an empty list.

fn subscribe( &self, _uri: &str, _ctx: &Context<'_>, ) -> impl Future<Output = Result<bool, McpError>> + Send

Subscribe to resource updates.

Returns true if the subscription was successful.

fn unsubscribe( &self, _uri: &str, _ctx: &Context<'_>, ) -> impl Future<Output = Result<bool, McpError>> + Send

Unsubscribe from resource updates.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T> ResourceHandler for Arc<T>

where T: ResourceHandler,

fn list_resources( &self, ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<Resource>, McpError>> + Send

fn list_resource_templates( &self, ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<ResourceTemplate>, McpError>> + Send

fn read_resource( &self, uri: &str, ctx: &Context<'_>, ) -> impl Future<Output = Result<Vec<ResourceContents>, McpError>> + Send

fn subscribe( &self, uri: &str, ctx: &Context<'_>, ) -> impl Future<Output = Result<bool, McpError>> + Send

fn unsubscribe( &self, uri: &str, ctx: &Context<'_>, ) -> impl Future<Output = Result<bool, McpError>> + Send

Implementors

impl ResourceHandler for ResourceService