Enum watchexec::error::CriticalError

#[non_exhaustive]
pub enum CriticalError {
    Exit,
    External(Box<dyn Error + Send + Sync>),
    IoError {
        about: &'static str,
        err: Error,
    },
    ErrorChannelSend(SendError<RuntimeError>),
    EventChannelSend(SendError<Event>),
    MainTaskJoin(JoinError),
    MissingHandler,
}

Errors which are not recoverable and stop watchexec execution.

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.

Exit

Pseudo-error used to signal a graceful exit.

External(Box<dyn Error + Send + Sync>)

For custom critical errors.

This should be used for errors by external code which are not covered by the other error types; watchexec-internal errors should never use this.

IoError

Fields

about: &'static str

What it was about.

err: Error

The I/O error which occurred.

A critical I/O error occurred.

ErrorChannelSend(SendError<RuntimeError>)

Error received when a runtime error cannot be sent to the errors channel.

EventChannelSend(SendError<Event>)

Error received when an event cannot be sent to the events channel.

MainTaskJoin(JoinError)

Error received when joining the main watchexec task.

MissingHandler

Error received when a handler is missing on initialisation.

This is a bug and should be reported.

Trait Implementations

impl Debug for CriticalError

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

Formats the value using the given formatter.

impl Diagnostic for CriticalError

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or Enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by [ReportHandler]s to change the display format of this diagnostic.

fn help(&'a self) -> Option<Box<dyn Display + 'a, Global>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url(&'a self) -> Option<Box<dyn Display + 'a, Global>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan>, Global>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related(
    &'a self
) -> Option<Box<dyn Iterator<Item = &'a (dyn Diagnostic + 'a)> + 'a, Global>>

Additional related Diagnostics.

impl Display for CriticalError

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

Formats the value using the given formatter.

impl Error for CriticalError

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

The lower-level source of this error, if any.

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

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<Box<dyn Error + Sync + Send + 'static, Global>> for CriticalError

fn from(source: Box<dyn Error + Send + Sync>) -> Self

Performs the conversion.

impl From<SendError<Event>> for CriticalError

fn from(source: SendError<Event>) -> Self

Performs the conversion.

impl From<SendError<RuntimeError>> for CriticalError

fn from(source: SendError<RuntimeError>) -> Self

Performs the conversion.