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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
use std::mem::MaybeUninit;
use crate::buf::*;
/// An IOCP compatible buffer.
///
/// The `IoBuf` trait is implemented by buffer types that can be passed to
/// IOCP operations. Users will not need to use this trait directly.
///
/// # Safety
///
/// Buffers passed to IOCP operations must reference a stable memory
/// region. While the runtime holds ownership to a buffer, the pointer returned
/// by `as_buf_ptr` must remain valid even if the `IoBuf` value is moved.
pub unsafe trait IoBuf: 'static {
/// Returns a raw pointer to the vector’s buffer.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// The implementation must ensure that, while the `compio` runtime
/// owns the value, the pointer returned **does not** change.
fn as_buf_ptr(&self) -> *const u8;
/// Number of initialized bytes.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// For [`Vec`], this is identical to `len()`.
fn buf_len(&self) -> usize;
/// Total size of the buffer, including uninitialized memory, if any.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// For [`Vec`], this is identical to `capacity()`.
fn buf_capacity(&self) -> usize;
/// Get the initialized part of the buffer.
fn as_slice(&self) -> &[u8] {
unsafe { std::slice::from_raw_parts(self.as_buf_ptr(), self.buf_len()) }
}
/// Returns a view of the buffer with the specified range.
///
/// This method is similar to Rust's slicing (`&buf[..]`), but takes
/// ownership of the buffer.
///
/// # Examples
///
/// ```
/// use compio::buf::IoBuf;
///
/// let buf = b"hello world";
/// buf.slice(5..10);
/// ```
fn slice(self, range: impl std::ops::RangeBounds<usize>) -> Slice<Self>
where
Self: Sized,
{
use std::ops::Bound;
let begin = match range.start_bound() {
Bound::Included(&n) => n,
Bound::Excluded(&n) => n + 1,
Bound::Unbounded => 0,
};
assert!(begin < self.buf_capacity());
let end = match range.end_bound() {
Bound::Included(&n) => n.checked_add(1).expect("out of range"),
Bound::Excluded(&n) => n,
Bound::Unbounded => self.buf_capacity(),
};
assert!(end <= self.buf_capacity());
assert!(begin <= self.buf_len());
Slice::new(self, begin, end)
}
}
unsafe impl IoBuf for Vec<u8> {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
unsafe impl IoBuf for &'static mut [u8] {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for &'static [u8] {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for String {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
unsafe impl IoBuf for &'static mut str {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
unsafe impl IoBuf for &'static str {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBuf for bytes::Bytes {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.len()
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBuf for bytes::BytesMut {
fn as_buf_ptr(&self) -> *const u8 {
self.as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
#[cfg(feature = "read_buf")]
unsafe impl IoBuf for std::io::BorrowedBuf<'static> {
fn as_buf_ptr(&self) -> *const u8 {
self.filled().as_ptr()
}
fn buf_len(&self) -> usize {
self.len()
}
fn buf_capacity(&self) -> usize {
self.capacity()
}
}
/// A mutable IOCP compatible buffer.
///
/// The `IoBufMut` trait is implemented by buffer types that can be passed to
/// IOCP operations. Users will not need to use this trait directly.
///
/// # Safety
///
/// Buffers passed to IOCP operations must reference a stable memory
/// region. While the runtime holds ownership to a buffer, the pointer returned
/// by `as_buf_mut_ptr` must remain valid even if the `IoBufMut` value is moved.
pub unsafe trait IoBufMut: IoBuf {
/// Returns a raw mutable pointer to the vector’s buffer.
///
/// This method is to be used by the `compio` runtime and it is not
/// expected for users to call it directly.
///
/// The implementation must ensure that, while the `compio` runtime
/// owns the value, the pointer returned **does not** change.
fn as_buf_mut_ptr(&mut self) -> *mut u8;
/// Get the uninitialized part of the buffer.
fn as_uninit_slice(&mut self) -> &mut [MaybeUninit<u8>] {
unsafe {
std::slice::from_raw_parts_mut(
self.as_buf_mut_ptr().add(self.buf_len()) as _,
self.buf_capacity() - self.buf_len(),
)
}
}
/// Updates the number of initialized bytes.
///
/// The specified `len` plus [`IoBuf::buf_len`] becomes the new value
/// returned by [`IoBuf::buf_len`].
fn set_buf_init(&mut self, len: usize);
}
unsafe impl IoBufMut for Vec<u8> {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
fn set_buf_init(&mut self, len: usize) {
unsafe { self.set_len(len + self.buf_len()) };
}
}
unsafe impl IoBufMut for &'static mut [u8] {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
fn set_buf_init(&mut self, len: usize) {
debug_assert!(len == 0)
}
}
#[cfg(feature = "bytes")]
unsafe impl IoBufMut for bytes::BytesMut {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.as_mut_ptr()
}
fn set_buf_init(&mut self, len: usize) {
unsafe { self.set_len(len + self.buf_len()) };
}
}
#[cfg(feature = "read_buf")]
unsafe impl IoBufMut for std::io::BorrowedBuf<'static> {
fn as_buf_mut_ptr(&mut self) -> *mut u8 {
self.filled().as_ptr() as _
}
fn set_buf_init(&mut self, len: usize) {
unsafe { self.unfilled().advance(len) };
}
}