Struct JsonRpcMethodRegistry 

pub struct JsonRpcMethodRegistry { /* private fields */ }

Thread-safe registry for JSON-RPC methods

Stores handlers along with their metadata. The registry uses Arc<RwLock> for thread-safe concurrent access with low contention for reads.

Example

use spikard_http::jsonrpc::method_registry::{JsonRpcMethodRegistry, MethodMetadata};
use std::sync::Arc;

let registry = JsonRpcMethodRegistry::new();

// Register a method (handler implementation omitted for brevity)
registry.register(
    "add",
    Arc::new(add_handler),
    MethodMetadata::new("add").with_description("Add two numbers"),
);

// Lookup a method
if let Some(handler) = registry.get("add") {
    // Use handler
}

Implementations

impl JsonRpcMethodRegistry

pub fn new() -> Self

Create a new empty method registry

pub fn register( &self, name: impl Into<String>, handler: Arc<dyn Handler>, metadata: MethodMetadata, ) -> Result<(), RegistryError>

Register a method with its handler and metadata

If a method with the same name already exists, it will be replaced.

Arguments

• name - The method name (e.g., “add”, “multiply”)
• handler - The handler that processes this method
• metadata - Metadata describing the method

Returns

Returns Ok(()) on success, or Err(RegistryError) if the lock cannot be acquired.

Example

let registry = JsonRpcMethodRegistry::new();
let handler = Arc::new(DummyHandler);
let metadata = MethodMetadata::new("test");
registry.register("test", handler, metadata)?;

pub fn get(&self, name: &str) -> Result<Option<Arc<dyn Handler>>, RegistryError>

Get a handler by method name

Returns None if the method is not registered.

Arguments

• name - The method name to look up

Returns

Ok(Option<Arc<dyn Handler>>) containing the handler if found, Ok(None) if not found, or Err(RegistryError) if the lock cannot be acquired.

pub fn get_metadata( &self, name: &str, ) -> Result<Option<MethodMetadata>, RegistryError>

Get metadata for a method by name

Returns None if the method is not registered.

Arguments

• name - The method name to look up

Returns

Ok(Option<MethodMetadata>) containing the metadata if found, Ok(None) if not found, or Err(RegistryError) if the lock cannot be acquired.

pub fn get_with_metadata( &self, name: &str, ) -> Result<Option<(Arc<dyn Handler>, MethodMetadata)>, RegistryError>

Get both handler and metadata for a method

Returns None if the method is not registered.

Arguments

• name - The method name to look up

Returns

Ok(Option<MethodEntry>) if found, Ok(None) if not found, or Err(RegistryError) if the lock cannot be acquired.

pub fn list_methods(&self) -> Result<Vec<String>, RegistryError>

List all registered method names

Returns

Ok(Vec<String>) containing all registered method names, sorted lexicographically, or Err(RegistryError) if the lock cannot be acquired.

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

Check if a method is registered

Arguments

• name - The method name to check

Returns

Ok(true) if the method is registered, Ok(false) if not, or Err(RegistryError) if the lock cannot be acquired.

pub fn len(&self) -> Result<usize, RegistryError>

Get the number of registered methods

Returns

Ok(usize) containing the count of registered methods, or Err(RegistryError) if the lock cannot be acquired.

pub fn is_empty(&self) -> Result<bool, RegistryError>

Check if the registry is empty

Returns

Ok(true) if no methods are registered, Ok(false) if any methods exist, or Err(RegistryError) if the lock cannot be acquired.

pub fn remove(&self, name: &str) -> Result<bool, RegistryError>

Remove a method from the registry

Returns Ok(true) if the method was removed, Ok(false) if it didn’t exist.

Arguments

• name - The method name to remove

Returns

Ok(true) if the method was removed, Ok(false) if not found, or Err(RegistryError) if the lock cannot be acquired.

pub fn clear(&self) -> Result<(), RegistryError>

Clear all methods from the registry

Returns

Ok(()) on success, or Err(RegistryError) if the lock cannot be acquired.

pub fn list_all( &self, ) -> Result<Vec<(String, Arc<dyn Handler>, MethodMetadata)>, RegistryError>

Get all methods with their metadata

Returns

Ok(Vec) containing tuples of method name, handler, and metadata, or Err(RegistryError) if the lock cannot be acquired.

Trait Implementations

impl Clone for JsonRpcMethodRegistry

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for JsonRpcMethodRegistry

fn default() -> Self

Returns the “default value” for a type.