Skip to main content

DimaError

Enum DimaError 

Source
#[non_exhaustive]
pub enum DimaError { Usage { message: String, hint: Option<String>, }, InputFormat { location: Box<Location>, message: String, hint: Option<String>, }, InputData { location: Option<Box<Location>>, message: String, hint: Option<String>, }, Io { action: IoAction, target: IoTarget, source: Error, }, System { what: String, source: Error, }, InputChanged { source_name: String, }, Cancelled, Overflow { what: &'static str, }, Internal { message: String, }, }
Expand description

Every error the library reports.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Usage

Invalid parameters (exit 2).

Fields

§message: String

What is wrong.

§hint: Option<String>

How to fix it.

§

InputFormat

The input is not a well-formed FASTA alignment (exit 4). Raised in every validation mode.

Fields

§location: Box<Location>

Where the problem is (boxed to keep Results small).

§message: String

What is wrong.

§hint: Option<String>

How to fix it.

§

InputData

The input is well-formed but its content is invalid or unsupported (exit 4).

Fields

§location: Option<Box<Location>>

Where the problem is, when it has a single location.

§message: String

What is wrong.

§hint: Option<String>

How to fix it.

§

Io

A file or stream could not be opened, read or written (exit 3).

Fields

§action: IoAction

The failed operation.

§target: IoTarget

The file or stream.

§source: Error

The operating-system error.

§

System

The operating system refused a resource the run needs, such as a thread (exit 3): the environment’s limits, not the input and not a bug.

Fields

§what: String

What could not be started, e.g. 8 worker threads.

§source: Error

The operating-system error.

§

InputChanged

The input’s first batch differs from what a pre-check saw (D108): the file changed after it was checked (exit 3; only front ends that pre-check, such as the desktop app, set the expectation).

Fields

§source_name: String

Display name of the input.

§

Cancelled

The operation was cancelled by the user or a signal.

§

Overflow

A 64-bit counter would overflow (exit 4).

Fields

§what: &'static str

The quantity that overflowed.

§

Internal

A broken internal invariant: a bug (exit 1).

Fields

§message: String

The invariant that failed.

Implementations§

Source§

impl DimaError

Source

pub fn usage(message: impl Into<String>) -> Self

A usage error without a hint.

Source

pub fn input_format(location: Location, message: impl Into<String>) -> Self

A structural input error at location.

Source

pub fn input_data( location: Option<Location>, message: impl Into<String>, ) -> Self

An invalid-data error, optionally at location.

Source

pub fn io(action: IoAction, target: IoTarget, source: Error) -> Self

An I/O error.

Source

pub fn system(what: impl Into<String>, source: Error) -> Self

A thread the run needs could not be started.

Source

pub fn internal(message: impl Into<String>) -> Self

An internal error (a bug).

Source

pub fn with_hint(self, new_hint: impl Into<String>) -> Self

Attaches a hint to errors that carry one; other errors are returned unchanged.

Source

pub fn hint(&self) -> Option<&str>

How to fix the error, if known.

Source

pub const fn class(&self) -> ExitClass

The exit class of the error.

Source

pub fn is_broken_pipe(&self) -> bool

true for a write to standard output that failed because the reader went away (dima … | head); front ends treat this as success.

Source

pub fn report(&self) -> String

The full report as plain text: the message, every caused by: line and the hint, one per line (used by the GUI and by tests).

Trait Implementations§

Source§

impl Debug for DimaError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for DimaError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for DimaError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more