Enum Compatibility 

#[non_exhaustive]
pub enum Compatibility {
    Exact,
    Compatible {
        dataset: BidsVersion,
        library: BidsVersion,
    },
    Newer {
        dataset: BidsVersion,
        library: BidsVersion,
    },
    Incompatible {
        reason: String,
    },
}

Result of checking a dataset’s BIDS version against the library’s supported version.

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.

Exact

Dataset version exactly matches the library’s target version.

Compatible

Dataset is from an older (but supported) spec version. Some newer features may not be present in the dataset.

Fields

dataset: BidsVersion

library: BidsVersion

Newer

Dataset declares a newer spec version than the library supports. The library may not understand new entities, datatypes, or conventions.

Fields

dataset: BidsVersion

library: BidsVersion

Incompatible

Dataset is fundamentally incompatible (different major version or below minimum supported version).

Fields

reason: String

Implementations

impl Compatibility

pub fn is_ok(&self) -> bool

Returns true if the dataset can be safely processed.

pub fn has_warnings(&self) -> bool

Returns true if processing may lose information or produce warnings.

pub fn is_incompatible(&self) -> bool

Returns true if the dataset should not be processed.

Trait Implementations

impl Clone for Compatibility

fn clone(&self) -> Compatibility

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compatibility

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

Formats the value using the given formatter.

impl Display for Compatibility

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

Formats the value using the given formatter.

impl PartialEq for Compatibility

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Compatibility

impl StructuralPartialEq for Compatibility