Struct ReplaceOptions 

pub struct ReplaceOptions {

    pub regex: bool,
    pub nth: Option<usize>,
    pub case_insensitive: bool,
    pub multiline: bool,
    pub insert_before: Option<String>,
    pub insert_after: Option<String>,
    pub whole_line: bool,
    pub range: Option<(usize, Option<usize>)>,
    pub if_exists: bool,
    pub word_boundary: bool,
    pub unique: bool,
    pub fuzzy: bool,
    pub before_context: Option<String>,
    pub after_context: Option<String>,
}

Options for text replacement operations.

Fields

regex: bool

Use regex mode for the from pattern.

nth: Option<usize>

Replace only the Nth match (1-based). None means replace all.

case_insensitive: bool

Case-insensitive matching.

multiline: bool

Enable multiline matching (dot matches newlines in regex mode).

insert_before: Option<String>

Text to insert before each match instead of replacing. Mutually exclusive with to (the replacement text) and insert_after.

insert_after: Option<String>

Text to insert after each match instead of replacing. Mutually exclusive with to (the replacement text) and insert_before.

whole_line: bool

Delete/replace entire lines containing the match rather than just the matched text. When to is empty, matching lines are removed.

range: Option<(usize, Option<usize>)>

Restrict matching to a 1-based inclusive line range (start, end). Requires whole_line to be true.

if_exists: bool

Return success (no error) even when the pattern matches nothing.

word_boundary: bool

When true, match only at word boundaries (\b in regex terms). Prevents SetupFile from matching inside BenchSetupFile. The pattern is auto-escaped for regex metacharacters before wrapping with \b anchors.

unique: bool

When true, the operation fails if the pattern matches more than once.

This enforces unambiguous edits: the caller is guaranteed that exactly one location was affected, or the operation is rejected with an error. Useful for AI coding agents that need to ensure each edit targets a unique location in the file.

fuzzy: bool

When true and the exact match fails (0 matches), attempt fuzzy resolution via resolve_with_fallback (anchor + similarity matching). On fuzzy success, the matched text is used for the replacement. On fuzzy failure, the error includes “did you mean?” suggestions. Only applies to literal (non-regex) patterns.

before_context: Option<String>

Context line(s) before the target for anchor-based fallback matching. When the pattern matches multiple times, the match nearest to this anchor text is selected.

after_context: Option<String>

Context line(s) after the target for anchor-based fallback matching. When the pattern matches multiple times, the match nearest to this anchor text is selected.

Trait Implementations

impl Clone for ReplaceOptions

fn clone(&self) -> ReplaceOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReplaceOptions

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

Formats the value using the given formatter.

impl Default for ReplaceOptions

fn default() -> ReplaceOptions

Returns the “default value” for a type.