Struct Error

pub struct Error { /* private fields */ }

An error that occurred during launch or ignition.

An Error is returned by Rocket::launch() or Rocket::ignite() on failure to launch or ignite, respectively. An Error may occur when the configuration is invalid, when a route or catcher collision is detected, or when a fairing fails to launch. An Error may also occur when the Rocket instance fails to liftoff or when the Rocket instance fails to shutdown. Finally, an Error may occur when a sentinel requests an abort.

To determine the kind of error that occurred, use Error::kind().

Example

use rocket::trace::Trace;
use rocket::error::ErrorKind;

if let Err(e) = rocket::build().ignite().await {
    match e.kind() {
        ErrorKind::Bind(_, e) => info!("binding failed: {}", e),
        ErrorKind::Io(e) => info!("I/O error: {}", e),
        _ => e.trace_error(),
    }

    return Err(e);
}

Implementations

impl Error

pub fn kind(&self) -> &ErrorKind

Returns the kind of error that occurred.

Example

use rocket::trace::Trace;
use rocket::error::ErrorKind;

if let Err(e) = rocket::build().ignite().await {
    match e.kind() {
        ErrorKind::Bind(_, e) => info!("binding failed: {}", e),
        ErrorKind::Io(e) => info!("I/O error: {}", e),
        _ => e.trace_error(),
   }
}

pub fn report<P: Phase>(result: Result<Rocket<P>, Error>) -> ExitCode

Given the return value of Rocket::launch() or Rocket::ignite(), which return a Result<Rocket<P>, Error>, logs the error, if any, and returns the appropriate exit code.

For Ok(_), returns ExitCode::SUCCESS. For Err(e), logs the error and returns ExitCode::FAILURE.

Example

use std::process::ExitCode;
use rocket::error::Error;

async fn run() -> ExitCode {
    Error::report(rocket::build().launch().await)
}

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn StdError + '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<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.

impl Trace for Error

fn trace(&self, level: Level)

fn trace_info(&self)

fn trace_warn(&self)

fn trace_error(&self)

fn trace_debug(&self)

fn trace_trace(&self)