karmaio 0.1.0

A modern, fast, share-nothing asynchronous runtime for Rust
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

use std::{rc::Rc, sync::Arc};

/// An immutable buffer for completion-based I/O operations.
///
/// Operations take ownership of buffers and keep them in stable storage while
/// the operating system may access them. Implementors only expose a normal
/// borrowed slice and therefore do not need to uphold raw-pointer stability.
pub trait IoBuf: 'static {
    /// Returns the initialized bytes available to an output operation.
    fn as_init(&self) -> &[u8];
}

impl<B: IoBuf + ?Sized> IoBuf for &'static B {
    #[inline]
    fn as_init(&self) -> &[u8] {
        (**self).as_init()
    }
}

impl<B: IoBuf + ?Sized> IoBuf for &'static mut B {
    #[inline]
    fn as_init(&self) -> &[u8] {
        (**self).as_init()
    }
}

impl<B: IoBuf + ?Sized> IoBuf for Box<B> {
    #[inline]
    fn as_init(&self) -> &[u8] {
        (**self).as_init()
    }
}

impl<B: IoBuf + ?Sized> IoBuf for Rc<B> {
    #[inline]
    fn as_init(&self) -> &[u8] {
        (**self).as_init()
    }
}

impl<B: IoBuf + ?Sized> IoBuf for Arc<B> {
    #[inline]
    fn as_init(&self) -> &[u8] {
        (**self).as_init()
    }
}

impl IoBuf for [u8] {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

impl<const N: usize> IoBuf for [u8; N] {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

impl IoBuf for Vec<u8> {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

impl IoBuf for str {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl IoBuf for String {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self.as_bytes()
    }
}

#[cfg(feature = "bytes")]
#[cfg_attr(docsrs, doc(cfg(feature = "bytes")))]
impl IoBuf for bytes::Bytes {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

#[cfg(feature = "bytes")]
#[cfg_attr(docsrs, doc(cfg(feature = "bytes")))]
impl IoBuf for bytes::BytesMut {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

#[cfg(feature = "memmap2")]
#[cfg_attr(docsrs, doc(cfg(feature = "memmap2")))]
impl IoBuf for memmap2::Mmap {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

#[cfg(feature = "memmap2")]
#[cfg_attr(docsrs, doc(cfg(feature = "memmap2")))]
impl IoBuf for memmap2::MmapMut {
    #[inline]
    fn as_init(&self) -> &[u8] {
        self
    }
}

#[cfg(all(test, feature = "bytes"))]
mod bytes_tests {
    use super::IoBuf;

    #[test]
    fn bytes_as_init_returns_initialized_bytes() {
        let buf = bytes::Bytes::from_static(b"hello");
        assert_eq!(buf.as_init(), b"hello");
    }

    #[test]
    fn bytes_mut_as_init_returns_initialized_prefix() {
        let mut buf = bytes::BytesMut::with_capacity(16);
        buf.extend_from_slice(b"abc");
        assert_eq!(buf.as_init(), b"abc");
    }

    #[test]
    fn bytes_can_be_copied_into_a_write_destination() {
        fn append<B: IoBuf>(dst: &mut Vec<u8>, buf: B) {
            dst.extend_from_slice(buf.as_init());
        }

        let mut dst = Vec::new();
        append(&mut dst, bytes::Bytes::from_static(b"hi"));
        assert_eq!(dst, b"hi");
    }
}

#[cfg(all(test, feature = "memmap2"))]
mod memmap2_tests {
    use super::IoBuf;

    #[test]
    fn mmap_as_init_returns_mapped_bytes() {
        let mut mmap_mut = memmap2::MmapMut::map_anon(5).unwrap();
        mmap_mut[..].copy_from_slice(b"hello");
        let mmap = mmap_mut.make_read_only().unwrap();
        assert_eq!(mmap.as_init(), b"hello");
    }

    #[test]
    fn mmap_mut_as_init_returns_all_mapped_bytes() {
        let mut buf = memmap2::MmapMut::map_anon(5).unwrap();
        buf[..].copy_from_slice(b"abcde");
        assert_eq!(buf.as_init(), b"abcde");
    }

    #[test]
    fn mmap_can_be_copied_into_a_write_destination() {
        fn append<B: IoBuf>(dst: &mut Vec<u8>, buf: B) {
            dst.extend_from_slice(buf.as_init());
        }

        let mut mmap_mut = memmap2::MmapMut::map_anon(2).unwrap();
        mmap_mut[..].copy_from_slice(b"hi");
        let mmap = mmap_mut.make_read_only().unwrap();

        let mut dst = Vec::new();
        append(&mut dst, mmap);
        assert_eq!(dst, b"hi");
    }
}