Document event_loop_factory usage

Add a couple of lines mentioning event_loop_factory - no clear error message is
given if you attempt to perform I/O in tasks created in this fashion.
This commit is contained in:
Robert Clipsham 2014-07-10 15:12:00 +01:00
parent a1bd5d359b
commit b5dd258884

View file

@ -164,10 +164,18 @@
//! possibly pinned to a particular scheduler thread:
//!
//! ```rust
//! extern crate green;
//! extern crate rustuv;
//!
//! # fn main() {
//! use std::task::TaskBuilder;
//! use green::{SchedPool, PoolConfig, GreenTaskBuilder};
//!
//! let config = PoolConfig::new();
//! let mut config = PoolConfig::new();
//!
//! // Optional: Set the event loop to be rustuv's to allow I/O to work
//! config.event_loop_factory = rustuv::event_loop;
//!
//! let mut pool = SchedPool::new(config);
//!
//! // Spawn tasks into the pool of schedulers
@ -195,6 +203,7 @@
//! // Required to shut down this scheduler pool.
//! // The task will fail if `shutdown` is not called.
//! pool.shutdown();
//! # }
//! ```
#![crate_name = "green"]