Document prep_readv with safety info. #35
Conversation
src/sqe.rs
Outdated
| /// Prepare an atomic vectored read using the `readv` system call. | ||
| /// | ||
| /// # Safety | ||
| /// You must ensure the file `fd` and destination buffer slice `bufs` outlive the event. |
There was a problem hiding this comment.
The requirements could be stated more precisely. The user needs to treat these as if the kernel has exclusive access to them until the completion occurs - they can't read or write to the bufs array or the buffers it points to and they can't pass the fd to kernel any syscalls like read/write/close (or schedule another event on the fd that isn't temporally linked to this one (ie using IOSQE_IO_LINK)
So I would at least change this to something like "ensure the kernel has exclusive access to the file and destination buffers until the end of the event"
There was a problem hiding this comment.
Thank you, fixed in fddd22b :)
Was having a little trouble with the wording.
mxxo
force-pushed
the
unsafe-docs
branch
2 times, most recently
from
fbf39b3 to
fddd22b
Compare
|
Closing in favour of overall library safety docs (https://github.com/ringbahn/iou/blob/master/src/lib.rs#L22-L24) |
Start work on #29. After reading through #27 I'd appreciate a second opinion on the safety info.