Enum WebSocketResponse

pub enum WebSocketResponse {
    Success(SuccessWebSocketResponse),
    Failure(FailureWebSocketResponse),
}

Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.

Variants

Success(SuccessWebSocketResponse)

Response sent when a request succeeded.

Failure(FailureWebSocketResponse)

Response sent when a request did not succeed.

Implementations

impl WebSocketResponse

pub fn success(request_id: Option<Uuid>, resp: OkWebSocketResponseData) -> Self

Make a new success response.

pub fn failure(request_id: Option<Uuid>, errors: Vec<ApiError>) -> Self

Make a new failure response.

pub fn is_success(&self) -> bool

Did the request succeed?

pub fn is_failure(&self) -> bool

Did the request fail?

pub fn request_id(&self) -> Option<Uuid>

Get the ID of whichever request this response is for.

Trait Implementations

impl Clone for WebSocketResponse

fn clone(&self) -> WebSocketResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WebSocketResponse

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for WebSocketResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.