Enum ClientMessage

Source
pub enum ClientMessage {
    Request(ClientJsonrpcRequest),
    Notification(ClientJsonrpcNotification),
    Response(ClientJsonrpcResponse),
    Error(JsonrpcError),
}
Expand description

“Similar to JsonrpcMessage, but with the variants restricted to client-side messages.” ClientMessage represents a message sent by an MCP Client and received by an MCP Server.

Variants§

Implementations§

Source§

impl ClientMessage

Source

pub fn as_response(self) -> Result<ClientJsonrpcResponse, RpcError>

Converts the current message into a ClientJsonrpcResponse if it’s of the correct type.

This function checks if the current message is of type Response. If so, it returns the ClientJsonrpcResponse wrapped in a Result::Ok. If the message is not a Response, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ClientJsonrpcResponse) if the message is a valid Response.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_request(self) -> Result<ClientJsonrpcRequest, RpcError>

Converts the current message into a ClientJsonrpcRequest if it’s of the correct type.

This function checks if the current message is of type Request. If so, it returns the ClientJsonrpcRequest wrapped in a Result::Ok. If the message is not a Request, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ClientJsonrpcRequest) if the message is a valid Request.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_notification(self) -> Result<ClientJsonrpcNotification, RpcError>

Converts the current message into a ClientJsonrpcNotification if it’s of the correct type.

This function checks if the current message is of type Notification. If so, it returns the ClientJsonrpcNotification wrapped in a Result::Ok. If the message is not a Notification, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ClientJsonrpcNotification) if the message is a valid Notification.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_error(self) -> Result<JsonrpcError, RpcError>

Converts the current message into a JsonrpcError if it’s of the correct type.

This function checks if the current message is of type Error. If so, it returns the JsonrpcError wrapped in a Result::Ok. If the message is not a Error, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(JsonrpcError) if the message is a valid Error.
  • Err(RpcError) if the message type is invalid

Trait Implementations§

Source§

impl Clone for ClientMessage

Source§

fn clone(&self) -> ClientMessage

Returns a copy 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 Debug for ClientMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClientMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ClientMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromMessage<CallToolRequest> for ClientMessage

Source§

fn from_message( message: CallToolRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<CancelledNotification> for ClientMessage

Source§

impl FromMessage<CompleteRequest> for ClientMessage

Source§

fn from_message( message: CompleteRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<CreateMessageResult> for ClientMessage

Source§

impl FromMessage<GetPromptRequest> for ClientMessage

Source§

fn from_message( message: GetPromptRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<InitializeRequest> for ClientMessage

Source§

fn from_message( message: InitializeRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<InitializedNotification> for ClientMessage

Source§

impl FromMessage<ListPromptsRequest> for ClientMessage

Source§

fn from_message( message: ListPromptsRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<ListResourceTemplatesRequest> for ClientMessage

Source§

impl FromMessage<ListResourcesRequest> for ClientMessage

Source§

impl FromMessage<ListRootsResult> for ClientMessage

Source§

fn from_message( message: ListRootsResult, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<ListToolsRequest> for ClientMessage

Source§

fn from_message( message: ListToolsRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<MessageFromClient> for ClientMessage

Source§

fn from_message( message: MessageFromClient, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<PingRequest> for ClientMessage

Source§

fn from_message( message: PingRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<ProgressNotification> for ClientMessage

Source§

impl FromMessage<ReadResourceRequest> for ClientMessage

Source§

impl FromMessage<Result> for ClientMessage

Source§

fn from_message( message: Result, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<RootsListChangedNotification> for ClientMessage

Source§

impl FromMessage<SetLevelRequest> for ClientMessage

Source§

fn from_message( message: SetLevelRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<SubscribeRequest> for ClientMessage

Source§

fn from_message( message: SubscribeRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromMessage<UnsubscribeRequest> for ClientMessage

Source§

fn from_message( message: UnsubscribeRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

Source§

impl FromStr for ClientMessage

Source§

type Err = RpcError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl McpMessage for ClientMessage

Source§

fn message_type(&self) -> MessageTypes

Determines the type of the message and returns the corresponding MessageTypes variant.

Source§

fn is_response(&self) -> bool

Source§

fn is_request(&self) -> bool

Source§

fn is_notification(&self) -> bool

Source§

fn is_error(&self) -> bool

Source§

impl RpcMessage for ClientMessage

Source§

impl Serialize for ClientMessage

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl ToMessage<ClientMessage> for CallToolRequest

Source§

impl ToMessage<ClientMessage> for CancelledNotification

Source§

impl ToMessage<ClientMessage> for CompleteRequest

Source§

impl ToMessage<ClientMessage> for CreateMessageResult

Source§

impl ToMessage<ClientMessage> for GetPromptRequest

Source§

impl ToMessage<ClientMessage> for InitializeRequest

Source§

impl ToMessage<ClientMessage> for InitializedNotification

Source§

impl ToMessage<ClientMessage> for ListPromptsRequest

Source§

impl ToMessage<ClientMessage> for ListResourceTemplatesRequest

Source§

impl ToMessage<ClientMessage> for ListResourcesRequest

Source§

impl ToMessage<ClientMessage> for ListRootsResult

Source§

impl ToMessage<ClientMessage> for ListToolsRequest

Source§

impl ToMessage<ClientMessage> for PingRequest

Source§

impl ToMessage<ClientMessage> for ProgressNotification

Source§

impl ToMessage<ClientMessage> for ReadResourceRequest

Source§

impl ToMessage<ClientMessage> for Result

Source§

impl ToMessage<ClientMessage> for RootsListChangedNotification

Source§

impl ToMessage<ClientMessage> for SetLevelRequest

Source§

impl ToMessage<ClientMessage> for SubscribeRequest

Source§

impl ToMessage<ClientMessage> for UnsubscribeRequest

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,