# rapid-delete-lib
A high-performance file deletion library, extracted from the
[turbo-delete](https://github.com/suptejas/turbo-delete) project.
## Overview
`rapid-delete-lib` provides a high-performance file
and directory deletion library, extracted from the
[turbo-delete](https://github.com/suptejas/turbo-delete) project.
Simple testing shows this library to be as fast as the OS's built-in methods.
## Features
- ⚡ High-performance file and directory deletion
- 🔧 Reusable library interface
- 🦀 Written in pure Rust
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
rapid-delete-lib = "0.3.1"
```
### Features
There is a `progressbar` feature that utilizes [indicatif](https://crates.io/crates/indicatif)
if a progress bar is desired.
## Usage
```rust
use rapid_delete::*;
fn main() {
// Add usage examples here
}
```
## Requirements
- Rust 1.70 or later (untested what an actual minimum version is).
- Platform support: Tested on Mac, but Windows and Linux should work as well.
## License
Licensed under either of:
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)
or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
## Acknowledgments
This library is derived from
[turbo-delete](https://github.com/suptejas/turbo-delete) by Tejas Ravishankar
(suptejas).
## Project Status
This is a library extraction from turbo-delete. For the full
application including CLI and context menu integration, see the original
[turbo-delete](https://github.com/suptejas/turbo-delete) project.