pub trait JsonRpcMessage:
'static
+ Debug
+ Sized
+ Send
+ Clone {
// Required methods
fn matches_method(method: &str) -> bool;
fn method(&self) -> &str;
fn to_untyped_message(&self) -> Result<UntypedMessage, Error>;
fn parse_message(method: &str, params: &Value) -> Result<Self, Error>;
}Expand description
Common bounds for any JSON-RPC message.
§Derive Macro
For simple message types, you can use the JsonRpcRequest or JsonRpcNotification derive macros
which will implement both JsonRpcMessage and the respective trait. See JsonRpcRequest and
JsonRpcNotification for examples.
Required Methods§
Sourcefn matches_method(method: &str) -> bool
fn matches_method(method: &str) -> bool
Check if this message type matches the given method name.
Sourcefn to_untyped_message(&self) -> Result<UntypedMessage, Error>
fn to_untyped_message(&self) -> Result<UntypedMessage, Error>
Convert this message into an untyped message.
§Errors
Returns an error if the message’s params cannot be encoded as JSON.
Sourcefn parse_message(method: &str, params: &Value) -> Result<Self, Error>
fn parse_message(method: &str, params: &Value) -> Result<Self, Error>
Parse this type from a method name and the message’s JSON params.
Callers should use matches_method first to check if this type handles the method.
A message without params is parsed from serde_json::Value::Null.
§Errors
Returns an error if the method doesn’t match or its params cannot be decoded.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".
Implementors§
impl JsonRpcMessage for agent_client_protocol::v1::schema::AgentNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::AgentNotification
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::AgentRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::AgentRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ArchiveSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ArchiveSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::AuthStatusRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::AuthStatusRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::AuthStatusUpdateNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::AuthStatusUpdateNotification
unstable_protocol_v2 only.impl JsonRpcMessage for AuthenticateRequest
impl JsonRpcMessage for CancelNotification
impl JsonRpcMessage for agent_client_protocol::v1::schema::CancelRequestNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::CancelRequestNotification
unstable_protocol_v2 only.impl JsonRpcMessage for CancelSessionNotification
unstable_protocol_v2 only.impl JsonRpcMessage for CancelTerminalRequest
unstable_protocol_v2 only.impl JsonRpcMessage for CancelToolCallRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ClientNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::ClientNotification
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ClientRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ClientRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::CloseSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::CloseSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::CompleteElicitationNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::CompleteElicitationNotification
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::CreateElicitationRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::CreateElicitationRequest
unstable_protocol_v2 only.impl JsonRpcMessage for CreateTerminalRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::DeleteSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::DeleteSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::DisableProviderRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::DisableProviderRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ForkSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ForkSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::InitializeProxyRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::InitializeProxyRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::InitializeRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::InitializeRequest
unstable_protocol_v2 only.impl JsonRpcMessage for KillTerminalRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::ListProvidersRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ListProvidersRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ListSessionsRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ListSessionsRequest
unstable_protocol_v2 only.impl JsonRpcMessage for LoadSessionRequest
impl JsonRpcMessage for LoginAuthRequest
unstable_protocol_v2 only.impl JsonRpcMessage for LogoutAuthRequest
unstable_protocol_v2 only.impl JsonRpcMessage for LogoutRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::MessageMcpNotification
unstable_mcp_over_acp only.impl JsonRpcMessage for agent_client_protocol::v2::schema::MessageMcpNotification
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::MessageMcpRequest
unstable_mcp_over_acp only.impl JsonRpcMessage for agent_client_protocol::v2::schema::MessageMcpRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::NewSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::NewSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::PromptRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::PromptRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ProtocolLevelNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::ProtocolLevelNotification
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ProxyNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::ProxyNotification
impl JsonRpcMessage for agent_client_protocol::v1::schema::ProxyRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ProxyRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::ProxySuccessorNotification
impl JsonRpcMessage for agent_client_protocol::v2::schema::ProxySuccessorNotification
impl JsonRpcMessage for agent_client_protocol::v1::schema::ProxySuccessorRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ProxySuccessorRequest
impl JsonRpcMessage for ReadTextFileRequest
impl JsonRpcMessage for ReleaseTerminalRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::RequestPermissionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::RequestPermissionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::ResumeSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::ResumeSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for SessionNotification
impl JsonRpcMessage for agent_client_protocol::v1::schema::SessionOptionsRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::SessionOptionsRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::SessionStatusRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::SessionStatusRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::SetProviderRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::SetProviderRequest
unstable_protocol_v2 only.impl JsonRpcMessage for agent_client_protocol::v1::schema::SetSessionConfigOptionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::SetSessionConfigOptionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for SetSessionModeRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::SetSessionTitleRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::SetSessionTitleRequest
unstable_protocol_v2 only.impl JsonRpcMessage for TerminalOutputRequest
impl JsonRpcMessage for agent_client_protocol::v1::schema::UnarchiveSessionRequest
impl JsonRpcMessage for agent_client_protocol::v2::schema::UnarchiveSessionRequest
unstable_protocol_v2 only.impl JsonRpcMessage for UntypedMessage
impl JsonRpcMessage for UpdateSessionNotification
unstable_protocol_v2 only.