Struct ServerError

pub struct ServerError {
    pub status_code: Option<StatusCode>,
    pub public_msg: Option<String>,
    pub private_msg: Option<Vec<String>>,
}

Data structure responsible for server errors.

Fields

status_code: Option<StatusCode>

Status code to return.

public_msg: Option<String>

Text to return (and hide error messages that leads to leak vulnerable data).

private_msg: Option<Vec<String>>

Text that really describes error situation.

Implementations

impl ServerError

pub fn from_private(err: impl Error + 'static) -> ServerError

Makes a new ServerError with actual error.

pub fn from_private_str(err: impl Into<String>) -> ServerError

Makes a new ServerError with actual error provided by plain string.

pub fn with_private_str(self, new_private_msg: impl Into<String>) -> ServerError

Adds a private message to the ServerError.

pub fn with_public(self, new_public_msg: impl Into<String>) -> ServerError

Adds a public message to the ServerError.

If ServerError already have a public message, it goes to private messages stack.

pub fn from_public(public_msg: impl Into<String>) -> ServerError

Makes a new Server Error from public message.

pub fn with_400(self) -> ServerError

Error BAD REQUEST (400).

pub fn with_401(self) -> ServerError

Error UNAUTHORIZED (401).

pub fn with_403(self) -> ServerError

Error FORBIDDEN (403).

pub fn with_404(self) -> ServerError

Error NOT FOUND (404).

pub fn with_405(self) -> ServerError

Error METHOD NOT ALLOWED (405).

pub fn with_500(self) -> ServerError

Error INTERNAL SERVER ERROR (500).

pub fn with_code(self, code: StatusCode) -> ServerError

Error LOCKED (423).

pub fn bail<T>(self) -> Result<T, ServerError>

Converts the ServerError into Result::Err.

Trait Implementations

impl Clone for ServerError

fn clone(&self) -> ServerError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerError

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

Formats the value using the given formatter.

impl Display for ServerError

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

Formats the value using the given formatter.

impl EndpointOutRegister for ServerError

fn register(components: &mut Components, operation: &mut Operation)

Registers error types for OpenAPI.

impl Error for ServerError

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 ExplicitServerWrite for ServerError

async fn explicit_write(self, res: &mut Response)

Write an actual response in a Response object.

impl Writer for ServerError

fn write<'life0, 'life1, 'life2, 'async_trait>( self, _req: &'life0 mut Request, _depot: &'life1 mut Depot, res: &'life2 mut Response, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, ServerError: 'async_trait,

Method for sending an error message to the client.