Struct BidsVersion 

pub struct BidsVersion {
    pub major: u16,
    pub minor: u16,
    pub patch: u16,
}

A parsed BIDS specification version (SemVer).

Examples

use bids_schema::version::BidsVersion;

let v = BidsVersion::parse("1.9.0").unwrap();
assert_eq!(v.major, 1);
assert_eq!(v.minor, 9);
assert_eq!(v.patch, 0);

let older = BidsVersion::parse("1.6.0").unwrap();
assert!(v > older);
assert!(v.is_compatible_with(&older));

Fields

major: u16

minor: u16

patch: u16

Implementations

impl BidsVersion

pub const fn new(major: u16, minor: u16, patch: u16) -> Self

Create a new version.

pub fn parse(s: &str) -> Option<Self>

Parse a version string like "1.9.0".

Accepts 2-part ("1.9") and 3-part ("1.9.0") versions. Returns None if parsing fails.

pub fn is_compatible_with(&self, other: &BidsVersion) -> bool

Check whether this version is compatible with other.

Two versions are compatible if they share the same major version and other is at least MIN_COMPATIBLE_VERSION.

pub fn is_older_than(&self, other: &BidsVersion) -> bool

Check whether other is from a newer spec than this version.

pub fn check_compatibility( &self, dataset_version: &BidsVersion, ) -> Compatibility

Return the compatibility status between this library version and a dataset’s declared BIDS version.

Trait Implementations

impl Clone for BidsVersion

fn clone(&self) -> BidsVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BidsVersion

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

Formats the value using the given formatter.

impl Display for BidsVersion

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

Formats the value using the given formatter.

impl FromStr for BidsVersion

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BidsVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BidsVersion

fn cmp(&self, other: &BidsVersion) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BidsVersion

fn eq(&self, other: &BidsVersion) -> 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 PartialOrd for BidsVersion

fn partial_cmp(&self, other: &BidsVersion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for BidsVersion

impl Eq for BidsVersion

impl StructuralPartialEq for BidsVersion