Struct JrRequestCx 

pub struct JrRequestCx<T: JrResponsePayload = Value> { /* private fields */ }

The context to respond to an incoming request.

This context is provided to request handlers and serves a dual role:

1. Respond to the request - Use respond or respond_with_result to send the response
2. Send other messages - Use connection_cx to access the underlying JrConnectionCx, giving access to send_request, send_notification, and spawn

Example

connection.on_receive_request(async |req: ProcessRequest, request_cx, cx| {
    // Send a notification while processing
    cx.send_notification(StatusUpdate {
        message: "processing".into(),
    })?;

    // Do some work...
    let result = process(&req.data)?;

    // Respond to the request
    request_cx.respond(ProcessResponse { result })
})

Event Loop Considerations

Like all handlers, request handlers run on the event loop. Use spawn for expensive operations to avoid blocking the connection.

See the Event Loop and Concurrency section for more details.

Implementations

impl JrRequestCx<Value>

pub fn cast<T: JrResponsePayload>(self) -> JrRequestCx<T>

Cast this request context to a different response type

impl<T: JrResponsePayload> JrRequestCx<T>

pub fn method(&self) -> &str

Method of the incoming request

pub fn id(&self) -> Value

ID of the incoming request as a JSON value

pub fn erase_to_json(self) -> JrRequestCx<Value>

Convert to a JrRequestCx that expects a JSON value and which checks (dynamically) that the JSON value it receives can be converted to T.

pub fn wrap_method(self, method: String) -> JrRequestCx<T>

Return a new JrResponse that expects a response of type U and serializes it.

pub fn wrap_params<U: JrResponsePayload>( self, wrap_fn: impl FnOnce(&str, Result<U, Error>) -> Result<T, Error> + Send + 'static, ) -> JrRequestCx<U>

Return a new JrResponse that expects a response of type U and serializes it.

wrap_fn will be invoked with the method name and the result of the wrapped function.

pub fn respond_with_result( self, response: Result<T, Error>, ) -> Result<(), Error>

Respond to the JSON-RPC request with either a value (Ok) or an error (Err).

pub fn respond(self, response: T) -> Result<(), Error>

Respond to the JSON-RPC request with a value.

pub fn respond_with_internal_error( self, message: impl ToString, ) -> Result<(), Error>

Respond to the JSON-RPC request with an internal error containing a message.

pub fn respond_with_error(self, error: Error) -> Result<(), Error>

Respond to the JSON-RPC request with an error.

Trait Implementations

impl<T: JrResponsePayload> Debug for JrRequestCx<T>

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

Formats the value using the given formatter.