Enum BidsError 

#[non_exhaustive]
pub enum BidsError {
    Io(Error),
    Json(Error),
    Validation(String),
    RootNotFound(String),
    MissingDatasetDescription,
    MissingMandatoryField {
        field: String,
    },
    DerivativesValidation(String),
    Entity(String),
    InvalidTarget(String),
    NoMatch(String),
    InvalidFilter(String),
    ConflictingValues(String),
    Database(String),
    Csv(String),
    Config(String),
    PathBuilding(String),
    FileType(String),
    Http(String),
    DataFormat(String),
    Network(String),
    Api(String),
}

Errors that can occur when working with BIDS datasets.

This enum covers all failure modes across the crate ecosystem, from low-level I/O errors to high-level BIDS validation failures. It implements From<std::io::Error> and From<serde_json::Error> for convenient error propagation with ?.

Example

use bids_core::BidsError;

let err = BidsError::validation("Missing required field");
assert!(err.is_validation());
assert!(!err.is_io());

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.

Io(Error)

Json(Error)

Validation(String)

RootNotFound(String)

MissingDatasetDescription

MissingMandatoryField

Fields

field: String

DerivativesValidation(String)

Entity(String)

InvalidTarget(String)

NoMatch(String)

InvalidFilter(String)

ConflictingValues(String)

Database(String)

Csv(String)

Config(String)

PathBuilding(String)

FileType(String)

Http(String)

DataFormat(String)

Network(String)

Api(String)

Implementations

impl BidsError

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

Create a validation error with a message.

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

Create an entity error with a message.

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

Create a data format error with a message.

pub fn is_io(&self) -> bool

Returns true if this is an I/O error.

pub fn is_validation(&self) -> bool

Returns true if this is a validation error.

pub fn is_not_found(&self) -> bool

Returns true if this is a “not found” type error.

Trait Implementations

impl Debug for BidsError

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

Formats the value using the given formatter.

impl Display for BidsError

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

Formats the value using the given formatter.

impl Error for BidsError

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<Error> for BidsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BidsError

fn from(source: Error) -> Self

Converts to this type from the input type.