Struct Editor

pub struct Editor { /* private fields */ }

Handle to a UTF-8 text file kept in memory until save is called.

All mutating methods return &mut self, enabling a fluent builder style.

Editor::open("Cargo.toml")?
    .insert_before("[dependencies]", "regex = \"1\"\n", false)
    .save()?;

Implementations

impl Editor

pub fn create<P: AsRef<Path>>(path: P) -> Result<Self>

Create or truncate a file and return an editor over it.

Equivalent to fs::write(path, "") followed by open.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open an existing UTF-8 file into an in-memory buffer.

pub fn rename<P: AsRef<Path>>(&mut self, new_name: P) -> Result<&mut Self>

Rename the underlying file on disk and update the internal path.

pub fn save(&mut self) -> Result<&mut Self>

Write the in-memory buffer back to disk iff it was modified.

Returns Ok(self) even when there was nothing to do.

pub fn prepend(&mut self, text: &str) -> &mut Self

Insert text at the beginning of the buffer.

pub fn append(&mut self, text: &str) -> &mut Self

Append text to the end of the buffer.

pub fn insert_before( &mut self, marker: &str, text: &str, same_indent: bool, ) -> &mut Self

Insert text before the first occurrence of marker.

• If same_indent is true, the current indentation of the line containing marker is copied and prepended to text.

pub fn insert_after( &mut self, marker: &str, text: &str, same_indent: bool, ) -> &mut Self

Insert text after the first occurrence of marker.

• If marker ends a line, the insertion starts on the next line.
• Otherwise the insertion is in-line; a space is auto-inserted when needed.
• When same_indent is true, every subsequent line in text is indented to match the marker line.

pub fn replace_marker( &mut self, marker: &str, text: &str, same_indent: bool, ) -> &mut Self

Replace the first occurrence of marker with text.

When same_indent is true, the replacement receives the indentation that preceded the marker.

pub fn find_lines<'a, P>(&self, pattern: P, limit: Option<usize>) -> Vec<usize>

where P: Into<Pattern<'a>>,

Return 1-based line numbers where pattern occurs.

Pass limit = Some(n) to cap the results.

pub fn erase<'a, P>(&mut self, pattern: P) -> &mut Self

where P: Into<Pattern<'a>>,

Erase all occurrences of pattern.

pub fn replace<'a, P>(&mut self, pattern: P, replacement: &str) -> &mut Self

where P: Into<Pattern<'a>>,

Replace all occurrences of pattern with replacement.

pub fn mask<'a, P>(&mut self, pattern: P, mask: &str) -> &mut Self

where P: Into<Pattern<'a>>,

Mask all occurrences of pattern with mask.

Trait Implementations

impl Clone for Editor

fn clone(&self) -> Editor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Editor

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

Formats the value using the given formatter.