pistonite-cu 0.8.4

Battery-included common utils to speed up development of rust tools
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::path::Path;

use crate::pre::*;

/// `std::fs::read` with tracing and error reporting
#[inline(always)]
pub fn read(path: impl AsRef<Path>) -> crate::Result<Vec<u8>> {
    read_impl(path.as_ref())
}
fn read_impl(path: &Path) -> crate::Result<Vec<u8>> {
    crate::trace!("read '{}'", path.display());
    crate::check!(
        std::fs::read(path),
        "failed to read file '{}' as bytes",
        path.display()
    )
}

/// Async version of [`read`]
#[cfg(feature = "coroutine")]
#[inline(always)]
pub async fn co_read(path: impl AsRef<Path>) -> crate::Result<Vec<u8>> {
    co_read_impl(path.as_ref()).await
}
#[cfg(feature = "coroutine")]
async fn co_read_impl(path: &Path) -> crate::Result<Vec<u8>> {
    crate::trace!("co_read '{}'", path.display());
    crate::check!(
        tokio::fs::read(path).await,
        "failed to read file '{}' as bytes",
        path.display()
    )
}

/// `std::fs::read_to_string` with tracing and error reporting
#[inline(always)]
pub fn read_string(path: impl AsRef<Path>) -> crate::Result<String> {
    read_string_impl(path.as_ref())
}
fn read_string_impl(path: &Path) -> crate::Result<String> {
    crate::trace!("read_string '{}'", path.display());
    crate::check!(
        std::fs::read_to_string(path),
        "failed to read file '{}' as string",
        path.display()
    )
}

/// Async version of [`read_string`]
#[cfg(feature = "coroutine")]
#[inline(always)]
pub async fn co_read_string(path: impl AsRef<Path>) -> crate::Result<String> {
    co_read_string_impl(path.as_ref()).await
}
#[cfg(feature = "coroutine")]
async fn co_read_string_impl(path: &Path) -> crate::Result<String> {
    crate::trace!("co_read_string '{}'", path.display());
    crate::check!(
        tokio::fs::read_to_string(path).await,
        "failed to read file '{}' as string",
        path.display()
    )
}

/// A buffered file reader
pub type Reader = std::io::BufReader<std::fs::File>;

/// Open a file for buffered reading
///
/// Note that using a reader only really makes a difference
/// if the file is large (i.e. does not fit in memory)
#[inline(always)]
pub fn reader(path: impl AsRef<Path>) -> crate::Result<Reader> {
    reader_impl(path.as_ref())
}
fn reader_impl(path: &Path) -> crate::Result<Reader> {
    crate::trace!("reader '{}'", path.display());
    let file = crate::check!(
        std::fs::File::open(path),
        "failed to open file '{}'",
        path.display()
    )?;
    Ok(std::io::BufReader::new(file))
}

/// A buffered async file reader
#[cfg(feature = "coroutine")]
pub type CoReader = tokio::io::BufReader<tokio::fs::File>;

/// Open a file for buffered asynchronous reading
///
/// Note that using a reader only really makes a difference
/// if the file is large (i.e. does not fit in memory)
#[cfg(feature = "coroutine")]
#[inline(always)]
pub async fn co_reader(path: impl AsRef<Path>) -> crate::Result<CoReader> {
    co_reader_impl(path.as_ref()).await
}
#[cfg(feature = "coroutine")]
async fn co_reader_impl(path: &Path) -> crate::Result<CoReader> {
    crate::trace!("co_reader '{}'", path.display());
    let file = crate::check!(
        tokio::fs::File::open(path).await,
        "failed to open file '{}'",
        path.display()
    )?;
    Ok(tokio::io::BufReader::new(file))
}