diff --git a/src/libstd/uv.rs b/src/libstd/uv.rs index 69168cc5c600..a6aeb5c9ffa8 100644 --- a/src/libstd/uv.rs +++ b/src/libstd/uv.rs @@ -1,8 +1,30 @@ +#[doc = " +Rust mappings to libuv (http://github.com/joyent/libuv) + +This crate provides a low-level mapping to libuv, a library for +running an asynchronous event loop, with extensive IO operations. + +This crate is seeing heavy work, currently, and the final API layout +should not be inferred from its current form. + +The base module contains a set of safe functions for creating +an event loop that runs within a single task, but allows operations +against it from other tasks, but funneling it through a uv_async +request which reads from a port that users write to. + +The 'll' module contains low-level, bare-metal mappings to the libuv +C-api. All functions within this module are marked unsafe and should +be used, primarily, for composing rust-idiomatic abstractions. In +lieu of satisfactory documention for the 'll' module, itself, libuv's +uv.h should be consulted. +"]; + import map::hashmap; export loop_new, loop_delete, run, close, run_in_bg; export async_init, async_send; export timer_init, timer_start, timer_stop; export uv_ip4_addr, uv_ip6_addr; +export direct; // these are processed solely in the // process_operation() crust fn below @@ -184,7 +206,7 @@ type uv_connect_t = { fn gen_stub_uv_connect_t() -> uv_connect_t { ret { a00: 0 as *u8, a01: 0 as *u8, a02: 0 as *u8, a03: 0 as *u8, - a01: 0 as *u8, a05: 0 as *u8 + a04: 0 as *u8, a05: 0 as *u8 }; } #[cfg(target_os = "win32")]