Crate tokio_iocp

Expand description

Tokio-iocp provides a safe IOCP interface for the Tokio runtime.

Getting started

Using tokio-iocp requires starting a tokio-iocp runtime. This runtime internally manages the main Tokio runtime and a IOCP handle.

use tokio_iocp::{fs::File, IoResult};

fn main() -> IoResult<()> {
    tokio_iocp::start(async {
        // Open a file
        let file = File::open("Cargo.toml")?;

        let buf = Vec::with_capacity(4096);
        // Read some data, the buffer is passed by ownership and
        // submitted to the kernel. When the operation completes,
        // we get the buffer back.
        let (res, buf) = file.read_at(buf, 0).await;
        let n = res?;

        // Display the contents
        println!("{}", String::from_utf8_lossy(&buf));

        Ok(())
    })
}

Under the hood, tokio_iocp::start starts a current-thread Runtime. For concurrency, spawn multiple threads, each with a tokio-iocp runtime.

Unlike Tokio proper, IOCP needs the ownership of resources. Ownership of resources are passed to the kernel, which then performs the operation. When the operation completes, ownership is passed back to the caller. Because of this difference, the tokio-iocp APIs diverge.

For example, in the above example, reading from a File requires passing ownership of the buffer.

Re-exports

pub use runtime::spawn;
pub use std::io::Error as IoError;
pub use std::io::Result as IoResult;

Modules

buf
Utilities for working with buffers.
fs
Filesystem manipulation operations.
net
TCP/UDP bindings for IOCP.
runtime
The runtime of Tokio with IOCP.

Functions

start
Start an IOCP enabled Tokio runtime.

Type Definitions