Enum axum::extract::ws::rejection::WebSocketUpgradeRejection

#[non_exhaustive]
pub enum WebSocketUpgradeRejection {
    MethodNotGet(MethodNotGet),
    InvalidConnectionHeader(InvalidConnectionHeader),
    InvalidUpgradeHeader(InvalidUpgradeHeader),
    InvalidWebSocketVersionHeader(InvalidWebSocketVersionHeader),
    WebSocketKeyHeaderMissing(WebSocketKeyHeaderMissing),
    ConnectionNotUpgradable(ConnectionNotUpgradable),
}

Rejection used for WebSocketUpgrade.

Contains one variant for each way the WebSocketUpgrade extractor can fail.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MethodNotGet(MethodNotGet)

InvalidConnectionHeader(InvalidConnectionHeader)

InvalidUpgradeHeader(InvalidUpgradeHeader)

InvalidWebSocketVersionHeader(InvalidWebSocketVersionHeader)

WebSocketKeyHeaderMissing(WebSocketKeyHeaderMissing)

ConnectionNotUpgradable(ConnectionNotUpgradable)

Implementations

impl WebSocketUpgradeRejection

pub fn body_text(&self) -> String

Get the response body text used for this rejection.

pub fn status(&self) -> StatusCode

Get the status code used for this rejection.

Trait Implementations

impl Debug for WebSocketUpgradeRejection

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

Formats the value using the given formatter.

impl Display for WebSocketUpgradeRejection

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

Formats the value using the given formatter.

impl Error for WebSocketUpgradeRejection

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 From<ConnectionNotUpgradable> for WebSocketUpgradeRejection

fn from(inner: ConnectionNotUpgradable) -> Self

Converts to this type from the input type.

impl From<InvalidConnectionHeader> for WebSocketUpgradeRejection

fn from(inner: InvalidConnectionHeader) -> Self

Converts to this type from the input type.

impl From<InvalidUpgradeHeader> for WebSocketUpgradeRejection

fn from(inner: InvalidUpgradeHeader) -> Self

Converts to this type from the input type.

impl From<InvalidWebSocketVersionHeader> for WebSocketUpgradeRejection

fn from(inner: InvalidWebSocketVersionHeader) -> Self

Converts to this type from the input type.

impl From<MethodNotGet> for WebSocketUpgradeRejection

fn from(inner: MethodNotGet) -> Self

Converts to this type from the input type.

impl From<WebSocketKeyHeaderMissing> for WebSocketUpgradeRejection

fn from(inner: WebSocketKeyHeaderMissing) -> Self

Converts to this type from the input type.

impl IntoResponse for WebSocketUpgradeRejection

fn into_response(self) -> Response

Create a response.