Struct SMError

pub struct SMError {
    pub kind: SMErrorKind,
    /* private fields */
}

WebSocket state machine errors

Fields

kind: SMErrorKind

Implementations

impl SMError

pub fn close_code(&self) -> CloseCode

pub fn invalid_message(description: String) -> Self

Trait Implementations

impl Debug for SMError

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

Formats the value using the given formatter.

impl Display for SMError

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

Formats the value using the given formatter.

impl Error for SMError

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<T> From<T> for SMError

where SMErrorKind: From<T>,

fn from(item: T) -> Self

Converts to this type from the input type.

impl ReportableError for SMError

fn reportable_source(&self) -> Option<&(dyn ReportableError + 'static)>

Like [Error::source] but returns the source (if any) of this error as a ReportableError if it implements the trait. Otherwise callers of this method will likely subsequently call [Error::source] to return the source (if any) as the parent [Error] trait.

fn backtrace(&self) -> Option<&Backtrace>

Return a Backtrace for this Error if one was captured

fn is_sentry_event(&self) -> bool

Whether this error is reported to Sentry

fn metric_label(&self) -> Option<&'static str>

Errors that don’t emit Sentry events (!is_sentry_event()) emit an increment metric instead with this label

fn tags(&self) -> Vec<(&str, String)>

Experimental: return tag key value pairs for metrics and Sentry

fn extras(&self) -> Vec<(&str, String)>

Experimental: return key value pairs for Sentry Event’s extra data TODO: should probably return Vec<(&str, Value)> or Vec<(String, Value)>