Struct BidsSchema 

pub struct BidsSchema {
    pub version: String,
    pub entities: Vec<EntityDef>,
    pub datatypes: HashSet<String>,
    pub suffixes: HashSet<String>,
    pub extensions: HashSet<String>,
    pub file_patterns: HashMap<String, Vec<Regex>>,
}

Full BIDS schema.

Fields

version: String

entities: Vec<EntityDef>

datatypes: HashSet<String>

suffixes: HashSet<String>

extensions: HashSet<String>

file_patterns: HashMap<String, Vec<Regex>>

Filename validation patterns: datatype → vec of regex.

Implementations

impl BidsSchema

pub fn load() -> Self

Load the bundled default schema.

pub fn check_dataset_version(&self, dataset_version_str: &str) -> Compatibility

Check compatibility between this schema and a dataset’s declared BIDS version.

Example

use bids_schema::{BidsSchema, BidsVersion};

let schema = BidsSchema::load();
let compat = schema.check_dataset_version("1.8.0");
assert!(compat.is_ok());

pub fn is_valid(&self, relative_path: &str) -> bool

Validate a relative file path against BIDS naming rules.

pub fn get_entity(&self, name: &str) -> Option<&EntityDef>

Get entity definition by name.

pub fn get_entity_by_key(&self, key: &str) -> Option<&EntityDef>

Get entity definition by BIDS key (e.g., “sub”, “ses”).

pub fn is_valid_datatype(&self, dt: &str) -> bool

Check if a datatype is valid.

pub fn is_valid_suffix(&self, s: &str) -> bool

Check if a suffix is valid.

pub fn is_valid_extension(&self, e: &str) -> bool

Check if an extension is valid.

pub fn entity_pattern(&self, name: &str) -> Option<String>

Generate a regex pattern string for an entity.

Trait Implementations

impl Clone for BidsSchema

fn clone(&self) -> BidsSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BidsSchema

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

Formats the value using the given formatter.