Struct BidsMetadata 

pub struct BidsMetadata {
    pub source_file: Option<String>,
    /* private fields */
}

Ordered metadata dictionary for a BIDS file.

Wraps an IndexMap<String, serde_json::Value> preserving insertion order. Provides typed accessors for common value types and can be deserialized into arbitrary structs via deserialize_as().

Metadata is populated from JSON sidecar files following the BIDS inheritance principle, where more-specific sidecars (closer to the data file) override less-specific ones (closer to the dataset root).

Corresponds to PyBIDS’ BIDSMetadata class.

Example

use bids_core::metadata::BidsMetadata;
use serde_json::json;

let mut md = BidsMetadata::new();
md.insert("SamplingFrequency".into(), json!(256.0));
md.insert("EEGReference".into(), json!("Cz"));

assert_eq!(md.get_f64("SamplingFrequency"), Some(256.0));
assert_eq!(md.get_str("EEGReference"), Some("Cz"));

Fields

source_file: Option<String>

The source file this metadata is associated with.

Implementations

impl BidsMetadata

pub fn new() -> Self

Create an empty metadata dictionary.

pub fn with_source(source_file: &str) -> Self

Create an empty metadata dictionary tagged with a source file path.

pub fn get(&self, key: &str) -> Option<&Value>

Get a raw JSON value by key.

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

Get a string value by key (returns None if missing or not a string).

pub fn get_f64(&self, key: &str) -> Option<f64>

Get a float value by key (returns None if missing or not numeric).

pub fn get_i64(&self, key: &str) -> Option<i64>

Get an integer value by key (returns None if missing or not numeric).

pub fn get_bool(&self, key: &str) -> Option<bool>

Get a boolean value by key.

pub fn get_array(&self, key: &str) -> Option<&Vec<Value>>

Get a JSON array value by key.

pub fn insert(&mut self, key: String, value: Value)

Insert a key-value pair, replacing any existing value.

pub fn extend(&mut self, other: BidsMetadata)

Merge all entries from other into this metadata (overwrites on conflict).

pub fn update_from_map(&mut self, map: IndexMap<String, Value>)

Merge entries from an IndexMap into this metadata.

pub fn contains_key(&self, key: &str) -> bool

Check if a key exists.

pub fn keys(&self) -> Keys<'_, String, Value>

Iterate over keys.

pub fn iter(&self) -> Iter<'_, String, Value>

Iterate over key-value pairs.

pub fn len(&self) -> usize

Number of metadata entries.

pub fn is_empty(&self) -> bool

Returns true if the metadata is empty.

impl BidsMetadata

pub fn deserialize_as<T: DeserializeOwned>(&self) -> Option<T>

Try to deserialize this metadata into a typed struct.

Works via JSON roundtrip: metadata map → serde_json::Value → T.

Trait Implementations

impl Clone for BidsMetadata

fn clone(&self) -> BidsMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BidsMetadata

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

Formats the value using the given formatter.

impl Default for BidsMetadata

fn default() -> BidsMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BidsMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BidsMetadata

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

Formats the value using the given formatter.

impl From<IndexMap<String, Value>> for BidsMetadata

fn from(map: IndexMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Map<String, Value>> for BidsMetadata

fn from(map: Map<String, Value>) -> Self

Converts to this type from the input type.

impl FromIterator<(String, Value)> for BidsMetadata

fn from_iter<I: IntoIterator<Item = (String, Value)>>(iter: I) -> Self

Creates a value from an iterator.

impl Index<&str> for BidsMetadata

fn index(&self, key: &str) -> &Value

Index into metadata by key.

Panics

Panics if the key is not present. Use get() for a non-panicking alternative.

type Output = Value

The returned type after indexing.

impl IntoIterator for BidsMetadata

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for BidsMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.