Struct Config 

pub struct Config {
    pub name: String,
    pub entities: Vec<Entity>,
    pub default_path_patterns: Option<Vec<String>>,
}

Configuration for a BIDS layout, defining entities and path patterns.

Corresponds to PyBIDS’ Config class. Can be loaded from JSON config files (like bids.json) or constructed programmatically.

Example

use bids_core::Config;

let config = Config::bids();
assert_eq!(config.name, "bids");
assert!(config.entity_count() > 20);
assert!(config.get_entity("subject").is_some());

Fields

name: String

entities: Vec<Entity>

default_path_patterns: Option<Vec<String>>

Implementations

impl Config

pub fn from_file(path: &Path) -> Result<Self>

Load a config from a JSON file.

Errors

Returns an error if the file cannot be read or contains invalid JSON.

pub fn bids() -> Self

Load the built-in BIDS config.

Panics

Panics if the embedded bids.json is malformed (should never happen).

pub fn derivatives() -> Self

Load the built-in derivatives config.

Panics

Panics if the embedded derivatives.json is malformed (should never happen).

pub fn load(name_or_path: &str) -> Result<Self>

Load a named config ("bids", "derivatives") or from a file path.

Errors

Returns an error if the name is unrecognized and the path doesn’t exist or contains invalid JSON.

pub fn entities_mut(&mut self) -> &mut Vec<Entity>

Get mutable references to all entity definitions.

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

Look up an entity definition by name.

pub fn entity_count(&self) -> usize

Returns the number of entity definitions in this config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Config

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

Formats the value using the given formatter.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.