fsys 1.1.0

Filesystem IO for Rust storage engines: journal substrate, io_uring, NVMe passthrough, atomic writes, cross-platform durability.
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Async wrappers for the `fsys::quick::*` one-shot helpers.
//!
//! Each function here is a thin [`tokio::task::spawn_blocking`] over
//! the corresponding sync function in [`crate::quick`]. Useful when
//! the caller doesn't have (or doesn't need) a long-lived
//! [`crate::Handle`] and just wants `await`-shaped one-shot IO.
//!
//! For repeated IO from inside an async context, prefer constructing
//! a [`crate::Handle`] once and using `Handle::*_async` — that avoids
//! the per-call `default_handle` lookup overhead from `quick::*`.

use crate::method::Method;
use crate::{Error, Result};
use std::path::{Path, PathBuf};

/// Async variant of [`crate::quick::write`].
///
/// # Errors
///
/// Returns [`Error::AsyncRuntimeRequired`] when called outside a
/// tokio runtime. Otherwise propagates [`crate::quick::write`].
///
/// # Examples
///
/// ```no_run
/// # async fn example() -> fsys::Result<()> {
/// fsys::async_io::quick::write_async("/tmp/foo", b"bar".to_vec()).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_async(path: impl AsRef<Path>, data: Vec<u8>) -> Result<()> {
    super::require_runtime()?;
    let path: PathBuf = path.as_ref().to_path_buf();
    tokio::task::spawn_blocking(move || crate::quick::write(&path, &data))
        .await
        .map_err(join_error_to_io)?
}

/// Async variant of [`crate::quick::write_with`].
pub async fn write_with_async(path: impl AsRef<Path>, data: Vec<u8>, method: Method) -> Result<()> {
    super::require_runtime()?;
    let path: PathBuf = path.as_ref().to_path_buf();
    tokio::task::spawn_blocking(move || crate::quick::write_with(&path, &data, method))
        .await
        .map_err(join_error_to_io)?
}

/// Async variant of [`crate::quick::read`].
pub async fn read_async(path: impl AsRef<Path>) -> Result<Vec<u8>> {
    super::require_runtime()?;
    let path: PathBuf = path.as_ref().to_path_buf();
    tokio::task::spawn_blocking(move || crate::quick::read(&path))
        .await
        .map_err(join_error_to_io)?
}

/// Async variant of [`crate::quick::delete`].
pub async fn delete_async(path: impl AsRef<Path>) -> Result<()> {
    super::require_runtime()?;
    let path: PathBuf = path.as_ref().to_path_buf();
    tokio::task::spawn_blocking(move || crate::quick::delete(&path))
        .await
        .map_err(join_error_to_io)?
}

fn join_error_to_io(e: tokio::task::JoinError) -> Error {
    Error::Io(std::io::Error::other(format!(
        "spawn_blocking task failed: {e}"
    )))
}