https://github.com/jwodder/in-place-rs

In-place file processing
https://github.com/jwodder/in-place-rs

available-on-crates-io edit in-place rust tempfile

Last synced: 20 days ago
JSON representation

In-place file processing

• Host: GitHub
• URL: https://github.com/jwodder/in-place-rs
• Owner: jwodder
• License: mit
• Created: 2023-05-17T02:13:34.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-25T16:22:04.000Z (4 months ago)
• Last Synced: 2024-09-15T03:19:19.902Z (2 months ago)
• Topics: available-on-crates-io, edit, in-place, rust, tempfile
• Language: Rust
• Homepage:
• Size: 67.4 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CI Status](https://github.com/jwodder/in-place-rs/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/in-place-rs/actions/workflows/test.yml)

[![codecov.io](https://codecov.io/gh/jwodder/in-place-rs/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/in-place-rs)

[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.74-orange)](https://www.rust-lang.org)

[![MIT License](https://img.shields.io/github/license/jwodder/in-place-rs.svg)](https://opensource.org/licenses/MIT)

[GitHub](https://github.com/jwodder/in-place-rs) | [crates.io](https://crates.io/crates/in-place) | [Documentation](https://docs.rs/in-place) | [Issues](https://github.com/jwodder/in-place-rs/issues) | [Changelog](https://github.com/jwodder/in-place-rs/blob/master/CHANGELOG.md)

The `in_place` library provides an `InPlace` type for reading & writing a file

"in-place": data that you write ends up at the same filepath that you read

from, and `in_place` takes care of all the necessary mucking about with

temporary files for you.

For example, given the file `somefile.txt`:

```text

'Twas brillig, and the slithy toves

    Did gyre and gimble in the wabe;

All mimsy were the borogoves,

    And the mome raths outgrabe.

```

and the following program:

```rust

use in_place::InPlace;

use std::io::{BufRead, BufReader, Write};

fn main() -> Result<(), Box> {

    let inp = InPlace::new("somefile.txt").open()?;

    let reader = BufReader::new(inp.reader());

    let mut writer = inp.writer();

    for line in reader.lines() {

        let mut line = line?;

        line.retain(|ch| !"AEIOUaeiou".contains(ch));

        writeln!(writer, "{line}")?;

    }

    inp.save()?;

    Ok(())

}

```

after running the program, `somefile.txt` will have been edited in place,

reducing it to just:

```text

'Tws brllg, nd th slthy tvs

    Dd gyr nd gmbl n th wb;

ll mmsy wr th brgvs,

    nd th mm rths tgrb.

```

and no sign of those pesky vowels remains!  If you want a sign of those pesky

vowels to remain, you can instead save the file's original contents in, say,

`somefile.txt~` by opening the file with:

```rust

let inp = InPlace::new("somefile.txt")

    .backup(in_place::Backup::Append("~".into()))

    .open()?;

```

or save to `someotherfile.txt` with:

```rust

let inp = InPlace::new("somefile.txt")

    .backup(in_place::Backup::Path("someotherfile.txt".into()))

    .open()?;

```

If you decide halfway through that you don't want to edit the file (say,

because an unrecoverable error occurs), calling `inp.discard()` instead of

`inp.save()` will close the file handles and reset things to the way they were

before.  Any changes are also discarded if `inp` is dropped without saving,

except that in that case any errors are silently ignored.