Struct RegexVersionFile 

pub struct RegexVersionFile { /* private fields */ }

A version file engine driven by a user-supplied regex.

The regex must contain at least one capture group. The first capture group is treated as the version string for both reading and writing.

Implementations

impl RegexVersionFile

pub fn new(custom: &CustomVersionFile) -> Result<Self, VersionFileError>

Create a new engine from a CustomVersionFile config entry.

Errors

Returns VersionFileError::InvalidRegex if the pattern fails to compile or contains no capture groups.

pub fn name(&self) -> String

Human-readable name (the file path as a string).

pub fn path(&self) -> &Path

The file path relative to the repository root.

pub fn detect(&self, content: &str) -> bool

Check if content contains a match for the regex pattern.

pub fn read_version(&self, content: &str) -> Option<String>

Extract the version string from the first capture group.

pub fn write_version( &self, content: &str, new_version: &str, ) -> Result<String, VersionFileError>

Return updated content with the first capture group replaced by new_version, preserving all surrounding text.

Errors

Returns VersionFileError::NoVersionField if the regex does not match content.

Trait Implementations

impl Debug for RegexVersionFile

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

Formats the value using the given formatter.