compio-io 0.10.0-rc.2

IO traits for completion based async IO
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

use futures_util::Stream;

use crate::{AsyncReadManaged, AsyncReadManagedAt, IoResult};

/// # AsyncReadMulti
///
/// Async read with buffer pool and returns a stream of managed buffers.
pub trait AsyncReadMulti: AsyncReadManaged {
    /// Read some bytes from this source and return a stream of
    /// [`AsyncReadManaged::Buffer`].
    ///
    /// # Implementation Note
    ///
    /// - If `len` == 0, implementation should use buffer's size as `len`
    /// - if `len` > 0, `min(len, buffer_size)` will be the max number of bytes
    ///   to be read each time.
    fn read_multi(&mut self, len: usize) -> impl Stream<Item = IoResult<Self::Buffer>>;
}

/// # AsyncReadMultiAt
///
/// Async read with buffer pool and position, returns a stream of managed
/// buffers.
pub trait AsyncReadMultiAt: AsyncReadManagedAt {
    /// Read some bytes from this source at position and return a stream of
    /// [`AsyncReadManagedAt::Buffer`].
    ///
    /// # Implementation Note
    ///
    /// - If `len` == 0, implementation should use buffer's size as `len`
    /// - if `len` > 0, `min(len, buffer_size)` will be the max number of bytes
    ///   to be read each time.
    fn read_multi_at(&self, len: usize, pos: u64) -> impl Stream<Item = IoResult<Self::Buffer>>;
}