Struct SuccessorMessage 

#[non_exhaustive]
pub struct SuccessorMessage<M: JsonRpcMessage = UntypedMessage> {
    pub message: M,
    pub meta: Option<Meta>,
}

A typed view of a proxy/successor envelope.

The schema’s ProxySuccessorRequest and ProxySuccessorNotification carry the wrapped message as a raw method name and raw params, with one copy of each type per protocol version. SuccessorMessage<M> holds the wrapped message as an SDK message type M instead and works for every protocol version. For a wrapped request its response type is the wrapped request’s response type, because the result of a wrapped request is returned unchanged as the result of proxy/successor.

Its JSON-RPC form is the schema envelope: the wrapped message’s method and params, next to the envelope’s optional _meta. The SDK’s proxy routing uses it to wrap and unwrap messages for a proxy’s successor.

Build one with SuccessorMessage::new and SuccessorMessage::meta.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: M

The message to be sent to the successor component.

meta: Option<Meta>

Metadata for the envelope itself, sent as _meta. The wrapped message keeps its own _meta in its params. A received _meta that is not an object is ignored, as the schema envelope specifies.

Implementations

impl<M: JsonRpcMessage> SuccessorMessage<M>

pub fn new(message: M) -> Self

Wrap message for the successor, without envelope metadata.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Set the envelope’s _meta object, replacing any existing metadata.

Trait Implementations

impl<M: Clone + JsonRpcMessage> Clone for SuccessorMessage<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + JsonRpcMessage> Debug for SuccessorMessage<M>

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

Formats the value using the given formatter.

impl<M: JsonRpcMessage> JsonRpcMessage for SuccessorMessage<M>

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &Value) -> Result<Self, Error>

Parse this type from a method name and the message’s JSON params.

impl<Notif: JsonRpcNotification> JsonRpcNotification for SuccessorMessage<Notif>

impl<Req: JsonRpcRequest> JsonRpcRequest for SuccessorMessage<Req>

type Response = <Req as JsonRpcRequest>::Response

The type of data expected in response.