Struct BidsFile 

pub struct BidsFile {
    pub path: PathBuf,
    pub filename: String,
    pub dirname: PathBuf,
    pub is_dir: bool,
    pub file_type: FileType,
    pub entities: Entities,
    pub metadata: BidsMetadata,
}

Represents a single file in a BIDS dataset.

This is the Rust equivalent of PyBIDS’ BIDSFile hierarchy (BIDSFile, BIDSDataFile, BIDSImageFile, BIDSJSONFile).

Example

use bids_core::file::BidsFile;

let f = BidsFile::new("/data/sub-01/eeg/sub-01_task-rest_eeg.edf");
assert_eq!(f.suffix(), Some("eeg"));
assert_eq!(f.extension(), ".edf");
assert_eq!(f.file_type, bids_core::FileType::Eeg);

Fields

path: PathBuf

Absolute path to the file.

filename: String

Just the filename component.

dirname: PathBuf

The parent directory.

is_dir: bool

Whether this entry represents a directory.

file_type: FileType

File type determined from extension.

entities: Entities

Entities extracted from the filename.

metadata: BidsMetadata

Metadata loaded from JSON sidecars (populated during metadata indexing).

Note: This field is skipped during serialization/deserialization. If you serialize a BidsFile and deserialize it back, metadata will be empty. Use BidsLayout::get_metadata() to re-populate after deserialization, or serialize metadata separately.

Implementations

impl BidsFile

pub fn new(path: impl AsRef<Path>) -> Self

Create a new BidsFile from a path.

pub fn with_entities(self, entities: Entities) -> Self

Set entities on this file, returning self for chaining.

pub fn with_metadata(self, metadata: BidsMetadata) -> Self

Set metadata on this file, returning self for chaining.

pub fn relpath(&self, root: &Path) -> Option<PathBuf>

Get the path relative to a root directory.

pub fn get_entities(&self, metadata: Option<bool>) -> Entities

Get a combined view of filename entities and metadata.

pub fn get_metadata(&self) -> &BidsMetadata

Get metadata for this file (from JSON sidecars).

pub fn extension(&self) -> &str

Get the full extension, including compound extensions like .tsv.gz.

Compound extensions are checked first (longest match wins).

pub fn suffix(&self) -> Option<&str>

Get the suffix (the part before the extension, after the last underscore).

pub fn companion(&self, suffix: &str, ext: &str) -> PathBuf

Find a companion file by replacing the suffix and extension.

E.g., for sub-01_task-rest_eeg.edf, companion("channels", "tsv") returns sub-01_task-rest_channels.tsv in the same directory.

pub fn get_json(&self) -> Result<Value, BidsError>

Read a JSON file and return as serde_json::Value.

Errors

Returns a BidsError::FileType if this file is not a JSON file, or an I/O / JSON parse error.

pub fn get_dict(&self) -> Result<HashMap<String, Value>, BidsError>

Read a JSON file and return as a HashMap.

Errors

Returns an error if the file is not JSON, can’t be read, or the top-level JSON value is not an object.

pub fn get_df(&self) -> Result<Vec<HashMap<String, String>>, BidsError>

Read a TSV/TSV.GZ file and return rows as Vec<HashMap<String, String>>.

Handles both plain .tsv and gzip-compressed .tsv.gz files. The BIDS sentinel value n/a is automatically converted to empty strings.

For bulk TSV processing, prefer bids_io::read_tsv / bids_io::read_tsv_gz which share the same parsing logic but don’t require a BidsFile.

Errors

Returns an error if the file cannot be read, is empty, or is not a tabular data file.

Example

let f = BidsFile::new("/data/sub-01/eeg/sub-01_events.tsv");
let rows = f.get_df().unwrap();
for row in &rows {
    println!("onset={}, type={}", row["onset"], row["trial_type"]);
}

pub fn copy_to(&self, new_path: &Path, mode: CopyMode) -> Result<(), BidsError>

Copy this file to a new location.

Accepts a CopyMode to control whether the file is copied or symlinked. Prefer the enum over a bare boolean for clarity.

Errors

Returns an I/O error if the source can’t be read or the destination can’t be created.

Trait Implementations

impl Clone for BidsFile

fn clone(&self) -> BidsFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BidsFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BidsFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BidsFile

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

Formats the value using the given formatter.

impl Ord for BidsFile

fn cmp(&self, other: &Self) -> 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 BidsFile

fn eq(&self, other: &Self) -> 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 BidsFile

fn partial_cmp(&self, other: &Self) -> 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 Serialize for BidsFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BidsFile