From c83b23ca6ca4c2f7ab3444b32acd77995096b573 Mon Sep 17 00:00:00 2001 From: Benedek Thaler Date: Sat, 17 Aug 2024 13:14:25 +0200 Subject: [PATCH] Add extra documentation to SendZc --- src/opcode.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/opcode.rs b/src/opcode.rs index 7a9f3d0..3ddc8fe 100644 --- a/src/opcode.rs +++ b/src/opcode.rs @@ -1662,6 +1662,12 @@ opcode! { /// /// A fixed (pre-mapped) buffer can optionally be used from pre-mapped buffers that have been /// previously registered with [`Submitter::register_buffers`](crate::Submitter::register_buffers). + /// + /// This operation might result in two completion queue entries. + /// See the `IORING_OP_SEND_ZC` section at [io_uring_enter][] for the exact semantics. + /// Notifications posted by this operation can be checked with [notif](crate::cqueue::notif). + /// + /// [io_uring_enter]: https://man7.org/linux/man-pages/man2/io_uring_enter.2.html pub struct SendZc { fd: { impl sealed::UseFixed }, buf: { *const u8 },