Skip to main content

Crate bids_schema

Crate bids_schema 

Source
Expand description

BIDS specification schema loader and version tracking.

Provides entity definitions, valid datatypes/suffixes/extensions, BIDS filename validation, and specification version management — replacing bidsschematools + bids-validator.

§Spec Version Tracking

All spec-derived knowledge is concentrated in this crate and in bids-core/src/configs/. When the BIDS spec releases a new version:

  1. Add a SpecChange entry to version::CHANGELOG.
  2. Update version::SUPPORTED_BIDS_VERSION.
  3. Update BidsSchema::built_in() with new entities/datatypes/suffixes.
  4. Update bids-core/src/configs/bids.json with new patterns.
  5. Run cargo test --workspace to catch regressions.

See the version module for full documentation on the migration process.

Re-exports§

pub use version::BidsVersion;
pub use version::Compatibility;
pub use version::MIN_COMPATIBLE_VERSION;
pub use version::SUPPORTED_BIDS_VERSION;

Modules§

version
BIDS specification version tracking and compatibility checking.

Structs§

BidsSchema
Full BIDS schema.
EntityDef
A BIDS entity definition from the schema.