Struct WSError 

pub struct WSError { /* private fields */ }

WebSocket error for both internal handling and client responses. Serializes as {"param": "...", "code": N, "msg": "..."} for JSON responses.

Implementations

impl WSError

pub fn new(code: ErrorCode) -> Self

Create error with default message from code

pub fn with_message(code: ErrorCode, message: impl Into<String>) -> Self

Create error with custom message

pub fn with_param( code: ErrorCode, param: impl Into<String>, message: impl Into<String>, ) -> Self

Create error with param context (for atomic batch failures)

pub fn error_code(&self) -> ErrorCode

Get the error code

pub fn code(&self) -> i32

Get the numeric error code

pub fn param(&self) -> Option<&str>

Get the param that caused the error

pub fn message(&self) -> &str

Get the error message

pub fn invalid_request(msg: impl Into<String>) -> Self

pub fn invalid_subscription(msg: impl Into<String>) -> Self

pub fn invalid_subscription_with_param( param: impl Into<String>, msg: impl Into<String>, ) -> Self

pub fn symbol_not_found(symbol: &str) -> Self

pub fn unauthorized(msg: impl Into<String>) -> Self

pub fn unauthorized_with_param( param: impl Into<String>, msg: impl Into<String>, ) -> Self

pub fn subscription_exists(param: impl Into<String>) -> Self

pub fn mandatory_param_missing(msg: impl Into<String>) -> Self

pub fn server_busy(msg: impl Into<String>) -> Self

Trait Implementations

impl Clone for WSError

fn clone(&self) -> WSError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WSError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WSError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WSError

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

Formats the value using the given formatter.

impl Error for WSError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Serialize for WSError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.