Struct Request 

pub struct Request {
    pub seq: i64,
    pub command: Command,
}

Represents a request from a client.

Note that unlike the specification, this implementation does not define a ProtocolMessage base interface. Instead, the only common part (the sequence number) is repeated in the struct.

Specification: Request

Fields

seq: i64

Sequence number for the Request.

From the specification:

Sequence number of the message (also known as message ID). The seq for the first message sent by a client or debug adapter is 1, and for each subsequent message is 1 greater than the previous message sent by that actor. seq can be used to order requests, responses, and events, and to associate requests with their corresponding responses. For protocol messages of type request the sequence number can be used to cancel the request.

command: Command

The command to execute.

This is stringly typed in the specification, but represented as an enum for better ergonomics in Rust code, along with the arguments when present.

Implementations

impl Request

pub fn success(self, body: ResponseBody) -> Response

Create a successful response for a given request. The sequence number will be copied from request, message will be None (as its neither cancelled nor an error). The body argument contains the response itself.

pub fn error(self, error: &str) -> Response

Create an error response for a given request. The sequence number will be copied from the request, message will be None (as its neither cancelled nor an error).

Arguments

• req: The request this response corresponds to.
• body: The body of the response to attach.

pub fn cancellation(self) -> Response

Create a cancellation response for the given request. The sequence number will be copied from the request, message will be ResponseMessage::Cancelled, success will be false, and body will be None.

pub fn ack(self) -> Result<Response, ServerError>

Create an acknowledgement response. This is a shorthand for responding to requests where the response does not require a body.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.