Enum dicom_encoding::adapters::DecodeError

#[non_exhaustive]
pub enum DecodeError {
    Custom {
        message: String,
        source: Option<Box<dyn Error + Send + Sync + 'static>>,
    },
    NotEncapsulated,
    FrameRangeOutOfBounds,
    MissingAttribute {
        name: &'static str,
    },
}

The possible error conditions when decoding (reading) pixel data.

Users of this type are free to handle errors based on their variant, but should not make decisions based on the display message, since that is not considered part of the API and may change on any new release.

Implementers of transfer syntaxes are recommended to choose the most fitting error variant for the tested condition. When no suitable variant is available, the Custom variant may be used. See also snafu for guidance on using context selectors.

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.

Custom

A custom error occurred when decoding, reported as a dynamic error value with a message.

The whatever! macro can be used to easily create an error of this kind.

Fields

message: String

The error message.

source: Option<Box<dyn Error + Send + Sync + 'static>>

The underlying error cause, if any.

NotEncapsulated

The input pixel data is not encapsulated.

Either the image needs no decoding or the compressed imaging data was in a flat pixel data element by mistake.

FrameRangeOutOfBounds

The requested frame range is outside the given object’s frame range.

MissingAttribute

A required attribute is missing from the DICOM object representing the image.

Fields

name: &'static str

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

where Self: Debug + Display,

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

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

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 ErrorCompat for DecodeError

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

Returns a Backtrace that may be printed.

fn iter_chain(&self) -> ChainCompat<'_, '_>

where Self: AsErrorSource,

Returns an iterator for traversing the chain of errors, starting with the current error and continuing with recursive calls to Error::source.

impl FromString for DecodeError

type Source = Box<dyn Error + Sync + Send>

The underlying error

fn without_source(message: String) -> Self

Create a brand new error from the given string

fn with_source(error: Self::Source, message: String) -> Self

Wrap an existing error with the given string

impl IntoError<DecodeError> for FrameRangeOutOfBoundsSnafu

where DecodeError: Error + ErrorCompat,

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> DecodeError

Combine the information to produce the error

impl<__T0> IntoError<DecodeError> for MissingAttributeSnafu<__T0>

where DecodeError: Error + ErrorCompat, __T0: Into<&'static str>,

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> DecodeError

Combine the information to produce the error

impl IntoError<DecodeError> for NotEncapsulatedSnafu

where DecodeError: Error + ErrorCompat,

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> DecodeError

Combine the information to produce the error