Struct ResourceRegistry 

pub struct ResourceRegistry { /* private fields */ }

A registry of resources and resource templates for dynamic dispatch.

Models MCP’s resources/list, resources/read, and resources/templates/list primitives. Tools provide actionable commands; resources provide readable context (static documents, log files, configuration snapshots).

Example

use llm_tool::{ResourceOutput, ResourceRegistry, RustResource, ToolError};

struct ConfigResource;

impl RustResource for ConfigResource {
    const NAME: &'static str = "config";
    const URI_TEMPLATE: &'static str = "file:///etc/app.conf";
    const DESCRIPTION: &'static str = "Application configuration";
    const MIME_TYPE: Option<&'static str> = Some("text/plain");
    type Params = ();

    async fn read(
        &self,
        uri: &str,
        _params: Self::Params,
    ) -> Result<ResourceOutput, ToolError> {
        Ok(ResourceOutput::text(uri, Some("text/plain"), "debug=true"))
    }
}

let mut reg = ResourceRegistry::new();
reg.register(ConfigResource);
assert_eq!(reg.len(), 1);
assert!(reg.matches("file:///etc/app.conf"));

Implementations

impl ResourceRegistry

pub const fn new() -> Self

Create a new, empty resource registry.

pub fn register<R: RustResource + 'static>(&mut self, resource: R) -> &mut Self

Register a RustResource.

Replaces any existing registration with the same RustResource::NAME.

pub fn with_resource<R: RustResource + 'static>(self, resource: R) -> Self

Register a RustResource, consuming and returning Self for chaining.

pub fn remove(&mut self, name: &str) -> bool

Remove a resource by name, returning true if it was present.

pub fn clear(&mut self)

Clear all registered resources.

pub fn definitions(&self) -> Vec<ResourceDefinition>

Collect ResourceDefinitions for all registered resources.

Returns clones of the cached definitions computed at registration time.

pub const fn len(&self) -> usize

Number of registered resources.

pub const fn is_empty(&self) -> bool

Whether the registry has no registered resources.

pub fn contains(&self, name: &str) -> bool

Whether a resource with the given name is registered.

Note that resources are read by URI (see matches), not by name; this checks the registered resource name for parity with ToolRegistry::contains.

pub fn matches(&self, uri: &str) -> bool

Whether any registered resource’s URI template matches uri.

This is the URI-keyed analog of contains and mirrors what read uses to select a resource.

pub fn definition(&self, name: &str) -> Option<&ResourceDefinition>

Borrow the cached ResourceDefinition for a registered resource by name.

Returns None if no resource named name is registered.

pub fn iter(&self) -> ResourceDefinitions<'_>

Iterate over (name, definition) pairs for every registered resource.

Yields clones of the cached definitions computed at registration time.

pub async fn read(&self, uri: &str) -> Result<ResourceOutput, ToolError>

Read the first resource whose URI template matches uri.

Errors

Returns ToolError::not_found if no registered resource’s template matches uri (carrying error_kind = "not_registered" metadata), or a read error if URI-variable deserialization or reading fails.

Trait Implementations

impl Debug for ResourceRegistry

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

Formats the value using the given formatter.

impl Default for ResourceRegistry

fn default() -> ResourceRegistry

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a ResourceRegistry

Iterate over (name, definition) pairs for every registered resource.

type Item = (&'static str, ResourceDefinition)

The type of the elements being iterated over.

type IntoIter = ResourceDefinitions<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.