Skip to main content

RpcOutcome

Enum RpcOutcome 

Source
pub enum RpcOutcome {
    Single(JsonRpcResponse),
    Batch(Vec<JsonRpcResponse>),
}
Expand description

A dispatched JSON-RPC result, ready to be inspected or rendered.

Returned by McpServer::handle_message. A None from that method means there is nothing to send (a notification, or a batch of only notifications); a Some is either a Single response object or a Batch array.

RpcOutcome implements Serialize and Display, both rendering a Single as a JSON object and a Batch as a JSON array. Use to_wire (or .to_string()) for a String, or write_json to append directly to a byte buffer — each serializes in a single pass with no intermediate serde_json::Value.

Variants§

§

Single(JsonRpcResponse)

A single JSON-RPC response object.

§

Batch(Vec<JsonRpcResponse>)

A JSON-RPC batch response array (always non-empty).

Implementations§

Source§

impl RpcOutcome

Source

pub fn to_wire(&self) -> String

Render this outcome to a single JSON wire string.

§Panics

Panics only if a well-formed MCP response fails to serialize, which would indicate a bug in this crate.

Source

pub fn write_json(&self, buf: &mut Vec<u8>)

Render this outcome’s JSON wire form by appending it to buf.

Lets callers reuse a single buffer across many responses, avoiding a fresh allocation per message.

§Panics

Panics only if a well-formed MCP response fails to serialize, which would indicate a bug in this crate.

Source

pub const fn is_batch(&self) -> bool

Returns true if this is a Batch of responses.

Source

pub fn into_responses(self) -> Vec<JsonRpcResponse>

Consume the outcome into a flat list of responses.

A Single yields a one-element Vec; a Batch yields its responses unchanged.

Trait Implementations§

Source§

impl Clone for RpcOutcome

Source§

fn clone(&self) -> RpcOutcome

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RpcOutcome

Source§

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

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

impl Display for RpcOutcome

Source§

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

Renders the JSON wire form (object for Single, array for Batch).

Source§

impl Eq for RpcOutcome

Source§

impl PartialEq for RpcOutcome

Source§

fn eq(&self, other: &RpcOutcome) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for RpcOutcome

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

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

impl StructuralPartialEq for RpcOutcome

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more