Struct Entity 

pub struct Entity {
    pub name: String,
    pub pattern: String,
    pub mandatory: bool,
    pub directory: Option<String>,
    pub dtype: String,
    /* private fields */
}

Represents a single entity defined in configuration.

Corresponds to PyBIDS Entity — a named key (e.g., “subject”, “task”) with a regex pattern to extract values from file paths.

Example

use bids_core::Entity;

let ent = Entity::new("subject", r"[/\\]+sub-([a-zA-Z0-9]+)");
let val = ent.match_path("/sub-01/anat/sub-01_T1w.nii.gz");
assert_eq!(val.unwrap().as_str_lossy(), "01");

Fields

name: String

pattern: String

mandatory: bool

directory: Option<String>

dtype: String

Implementations

impl Entity

pub fn new(name: &str, pattern: &str) -> Self

Create a new entity.

Eagerly compiles the regex. If the pattern is invalid, the entity will never match any path. Prefer Entity::try_new() when working with user-supplied patterns so you can surface the error.

pub fn try_new(name: &str, pattern: &str) -> Result<Self, Error>

Create a new entity, returning an error if the regex pattern is invalid.

Errors

Returns regex::Error if pattern is not a valid regular expression.

pub fn with_dtype(self, dtype: &str) -> Self

Set the data type ("str", "int", "float", "bool").

pub fn with_directory(self, directory: &str) -> Self

Set the directory pattern for this entity.

pub fn with_mandatory(self, mandatory: bool) -> Self

Mark this entity as mandatory.

pub fn regex(&self) -> Option<&Regex>

Return the compiled regex, lazily compiling on first access.

Returns None if the pattern is invalid. Only requires &self.

pub fn match_path(&self, path: &str) -> Option<EntityValue>

Match the entity pattern against a file path. Returns the captured value if found.

Only requires &self (no mutable borrow needed).

pub fn coerce_value(&self, val: &str) -> EntityValue

Coerce a string value to the appropriate type.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Entity

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

Formats the value using the given formatter.

impl Serialize for Entity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.