Struct InputError 

pub struct InputError(pub String);

Input an algorithm cannot process: too few echoes, echo times it cannot use, buffers that do not match the grid, a singular affine, and so on. The message says what was wrong and with what values, so a host can pass it straight to its user.

Algorithms return this instead of panicking. A host that wants to reject a run before any work starts should still check its parameters itself (the message here is the last line of defence, not a substitute for validating a config).

The pipeline stages convert it to PipelineError::InvalidInput.

Tuple Fields

0: String

Implementations

impl InputError

pub fn new(msg: impl Into<String>) -> Self

An error with this message.

pub fn param(name: &str, value: impl Display, allowed: &str) -> Self

A parameter outside the range the algorithm accepts, as "{name} = {value} is out of range: must be {allowed}". name should say whose parameter it is ("V-SHARP min_radius"), and allowed the range with its unit ("finite and > 0 mm"), so the message stands on its own in a host’s error report.

Trait Implementations

impl Clone for InputError

fn clone(&self) -> InputError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputError

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

Formats the value using the given formatter.

impl Display for InputError

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

Formats the value using the given formatter.

impl Eq for InputError

impl Error for InputError

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<InputError> for PipelineError

fn from(e: InputError) -> Self

Converts to this type from the input type.

impl PartialEq for InputError

fn eq(&self, other: &InputError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for InputError