kayrx 0.7.5

The Kayrx Framework
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

//! Asynchronous file and standard stream adaptation.
//!
//! This module contains utility methods and adapter types for input/output to
//! files or standard streams (`Stdin`, `Stdout`, `Stderr`), and
//! filesystem manipulation, for use within (and only within) a Tokio runtime.
//!
//! Tasks run by *worker* threads should not block, as this could delay
//! servicing reactor events. Portable filesystem operations are blocking,
//! however. This module offers adapters which use a `blocking` annotation
//! to inform the runtime that a blocking operation is required. When
//! necessary, this allows the runtime to convert the current thread from a
//! *worker* to a *backup* thread, where blocking is acceptable.
//!
//! ## Usage
//!
//! Where possible, users should prefer the provided asynchronous-specific
//! traits such as `AsyncRead`, or methods returning a `Future` or `Poll`
//! type. Adaptions also extend to traits like `std::io::Read` where methods
//! return `std::io::Result`. Be warned that these adapted methods may return
//! `std::io::ErrorKind::WouldBlock` if a *worker* thread can not be converted
//! to a *backup* thread immediately.
//!

mod file;
mod create_dir;
mod create_dir_all;
mod hard_link;
mod metadata;
mod open_options;
mod read;
mod read_dir;
mod read_link;
mod read_to_string;
mod remove_dir;
mod remove_dir_all;
mod remove_file;
mod rename;
mod set_permissions;
mod symlink_metadata;
mod write;

/// OS-specific functionality.
pub mod linux;

pub use self::create_dir::create_dir;
pub use self::create_dir_all::create_dir_all;
pub use self::file::File;
pub use self::hard_link::hard_link;
pub use self::metadata::metadata;
pub use self::open_options::OpenOptions;
pub use self::read::read;
pub use self::read_dir::{read_dir, DirEntry, ReadDir};
pub use self::read_link::read_link;
pub use self::read_to_string::read_to_string;
pub use self::remove_dir::remove_dir;
pub use self::remove_dir_all::remove_dir_all;
pub use self::remove_file::remove_file;
pub use self::rename::rename;
pub use self::set_permissions::set_permissions;
pub use self::symlink_metadata::symlink_metadata;
pub use self::write::write;

use std::io;


pub(crate) async fn asyncify<F, T>(f: F) -> io::Result<T>
where
    F: FnOnce() -> io::Result<T> + Send + 'static,
    T: Send + 'static,
{
    match sys::run(f).await {
        Ok(res) => res,
        Err(_) => Err(io::Error::new(
            io::ErrorKind::Other,
            "background task failed",
        )),
    }
}

/// Types in this module can be mocked out in tests.
mod sys {
    pub(crate) use std::fs::File;

    // TODO: don't rename
    pub(crate) use crate::fiber::spawn_blocking as run;
    pub(crate) use crate::fiber::JoinHandle as Blocking;
}