fs 0.0.6

Asynchronous filesystem operations on a dedicated blocking thread pool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# fs

[![CI](https://github.com/liuchong/futures-fs/actions/workflows/ci.yml/badge.svg)](https://github.com/liuchong/futures-fs/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/fs.svg)](https://crates.io/crates/fs)
[![Documentation](https://docs.rs/fs/badge.svg)](https://docs.rs/fs)
[![MSRV](https://img.shields.io/badge/MSRV-1.85-blue.svg)](https://www.rust-lang.org)
[![License](https://img.shields.io/crates/l/fs.svg)](LICENSE-MIT)

Asynchronous filesystem operations using futures 0.3. Blocking file I/O runs
on a dedicated worker pool instead of the thread driving the futures.

## Usage

```rust
use fs::FsPool;
use futures::executor::block_on;
use futures::StreamExt;
use std::io;

fn main() -> io::Result<()> {
    // Choose the number of threads reserved for blocking filesystem work.
    let fs = FsPool::new(4);

    block_on(async {
        let reader = fs.read("input.txt", Default::default());
        let writer = fs.write("output.txt", Default::default());

        reader.forward(writer).await
    })
}
```

`FsReadStream` yields `io::Result<bytes::Bytes>` chunks. `FsWriteSink`
implements `futures::Sink<bytes::Bytes>`, and operations such as `delete`
return futures that can be awaited directly.