Skip to main content

VectoredWriteFuture

Struct VectoredWriteFuture 

Source
pub struct VectoredWriteFuture<'ring, 'buf> { /* private fields */ }
Expand description

Future for vectored write operations.

This future handles gather writes that operate on multiple buffers simultaneously, allowing for efficient I/O when data from multiple non-contiguous memory regions needs to be written in a single operation. Returns the total bytes written and ownership of all buffers when complete.

§Type Parameters

  • 'ring - Lifetime of the io_uring Ring instance
  • 'buf - Lifetime of all buffers used for the vectored write

§Returns

Returns (usize, Vec<Pin<&'buf mut [u8]>>) on success where:

  • usize is the total number of bytes written from all buffers
  • Vec<Pin<&'buf mut [u8]>> are all the buffers that were written from

§Examples

let mut ring = Ring::new(32)?;
let file = OpenOptions::new()
    .write(true)
    .create(true)
    .open("output.bin")?;

// Create buffers for vectored write
let mut header_buf = PinnedBuffer::from_slice(b"HEADER: ");
let mut data_buf = PinnedBuffer::from_slice(b"Important data content");
let buffers = vec![header_buf.as_mut_slice(), data_buf.as_mut_slice()];

let write_future = ring.write_vectored(file.as_raw_fd(), buffers)?;
let (total_bytes, _buffers) = write_future.await?;

println!("Wrote {} bytes total", total_bytes);

Trait Implementations§

Source§

impl<'ring, 'buf> Drop for VectoredWriteFuture<'ring, 'buf>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl<'ring, 'buf> Future for VectoredWriteFuture<'ring, 'buf>

Source§

type Output = Result<(usize, Vec<Pin<&'buf mut [u8]>>), Error>

The type of value produced on completion.
Source§

fn poll(self: StdPin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl<'ring, 'buf> !RefUnwindSafe for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> !UnwindSafe for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> Freeze for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> Send for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> Sync for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> Unpin for VectoredWriteFuture<'ring, 'buf>

§

impl<'ring, 'buf> UnsafeUnpin for VectoredWriteFuture<'ring, 'buf>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.