orengine 0.7.0-alpha.1

Optimized ring engine for Rust. It is a lighter and faster asynchronous library than tokio-rs, async-std, may, and even smol.
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::io::{Buffer, FixedBuffer, FixedBufferMut, SendableSlice, SendableSliceMut};
use crate::utils::Sealed;
use std::collections::Bound;
use std::ops::{Deref, DerefMut, RangeBounds};

/// `SendableBuffer` is a wrapper struct that tells the compiler that the [`Buffer`] is
/// [`sendable`](Send). But only The caller  should ensure that it never sends to another thread.
///
/// ```no_run
/// use std::ops::Deref;
/// use orengine::Executor;
/// use orengine::fs::File;
/// use orengine::io::{buffer, AsyncWrite, SendableBuffer};
///
/// Executor::init().run_and_block_on_shared(async {
///     let mut file = File::open("./example.txt", &orengine::fs::OpenOptions::new().read(true))
///         .await
///         .unwrap();
///     let mut buffer = unsafe { SendableBuffer::from_buffer(buffer()) };
///     buffer.append("Hello, world!".as_bytes());
///     file.write_all(&mut buffer).await.unwrap();
/// }).unwrap();
/// ```
pub struct SendableBuffer {
    buf: Buffer,
}

impl SendableBuffer {
    /// Creates [`SendableBuffer`] from [`Buffer`].
    ///
    /// # Safety
    ///
    /// The caller must ensure that the [`Buffer`] never sends to another thread.
    pub unsafe fn from_buffer(buffer: Buffer) -> Self {
        Self { buf: buffer }
    }

    /// Returns [`SendableSlice`] with the specified range.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use orengine::Executor;
    /// use orengine::fs::{File, OpenOptions};
    /// use orengine::io::{buffer, AsyncRead, AsyncWrite, SendableBuffer};
    ///
    /// # Executor::init().run_and_block_on_shared(async {
    /// let mut file = File::open("./foo.txt", &OpenOptions::new().write(true).create(true)).await.unwrap();
    /// let mut buf = unsafe { SendableBuffer::from_buffer(buffer()) };
    ///
    /// file.read_exact(&mut buf.slice_mut(..100)).await.unwrap(); // read exactly 100 bytes
    /// # }).unwrap();
    pub fn slice<R: RangeBounds<u32>>(&self, range: R) -> SendableSlice {
        let start = match range.start_bound() {
            Bound::Included(s) => *s,
            Bound::Unbounded => 0,
            Bound::Excluded(s) => *s + 1,
        };

        let end = match range.end_bound() {
            Bound::Included(e) => *e + 1,
            Bound::Excluded(e) => *e,
            Bound::Unbounded => self.len_u32(),
        };

        SendableSlice::new(self, start, end)
    }

    /// Returns [`SendableSlice`] with the specified range.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use orengine::Executor;
    /// use orengine::fs::{File, OpenOptions};
    /// use orengine::io::{full_buffer, AsyncWrite, SendableBuffer};
    ///
    /// # Executor::init().run_and_block_on_shared(async {
    /// let mut file = File::open("./foo.txt", &OpenOptions::new().read(true).write(true).create(true)).await.unwrap();
    /// let mut buf = unsafe { SendableBuffer::from_buffer(full_buffer()) };
    ///
    /// buf.append(&*vec![1u8; 200]);
    ///
    /// file.write_all(&mut buf.slice(..100)).await.unwrap(); // write exactly 100 bytes
    /// # }).unwrap();
    /// ```
    pub fn slice_mut<R: RangeBounds<u32>>(&mut self, range: R) -> SendableSliceMut {
        let start = match range.start_bound() {
            Bound::Included(s) => *s,
            Bound::Unbounded => 0,
            Bound::Excluded(s) => *s + 1,
        };

        let end = match range.end_bound() {
            Bound::Included(e) => *e + 1,
            Bound::Excluded(e) => *e,
            Bound::Unbounded => self.len_u32(),
        };

        SendableSliceMut::new(self, start, end)
    }
}

#[allow(
    clippy::non_send_fields_in_send_ty,
    reason = "The caller  guarantees that `SendableBuffer` is `Send`."
)]
unsafe impl Send for SendableBuffer {}
unsafe impl Sync for SendableBuffer {}

impl Deref for SendableBuffer {
    type Target = Buffer;

    fn deref(&self) -> &Self::Target {
        &self.buf
    }
}

impl DerefMut for SendableBuffer {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.buf
    }
}

impl Sealed for SendableBuffer {}

impl FixedBuffer for SendableBuffer {
    fn as_ptr(&self) -> *const u8 {
        self.buf.as_ptr()
    }

    fn len_u32(&self) -> u32 {
        self.buf.len_u32()
    }

    fn fixed_index(&self) -> u16 {
        self.buf.fixed_index()
    }

    fn is_fixed(&self) -> bool {
        self.buf.is_fixed()
    }
}

impl FixedBufferMut for SendableBuffer {
    fn as_mut_ptr(&mut self) -> *mut u8 {
        self.buf.as_mut_ptr()
    }
}