1
Fork 0

auto merge of #15576 : mrmonday/rust/patch-1, r=alexcrichton

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. I spent a many hours debugging this yesterday which would have been avoided if it were documented.
This commit is contained in:
bors 2014-07-11 12:06:40 +00:00
commit c9a77d03dd

View file

@ -164,10 +164,18 @@
//! possibly pinned to a particular scheduler thread: //! possibly pinned to a particular scheduler thread:
//! //!
//! ```rust //! ```rust
//! extern crate green;
//! extern crate rustuv;
//!
//! # fn main() {
//! use std::task::TaskBuilder; //! use std::task::TaskBuilder;
//! use green::{SchedPool, PoolConfig, GreenTaskBuilder}; //! 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); //! let mut pool = SchedPool::new(config);
//! //!
//! // Spawn tasks into the pool of schedulers //! // Spawn tasks into the pool of schedulers
@ -195,6 +203,7 @@
//! // Required to shut down this scheduler pool. //! // Required to shut down this scheduler pool.
//! // The task will fail if `shutdown` is not called. //! // The task will fail if `shutdown` is not called.
//! pool.shutdown(); //! pool.shutdown();
//! # }
//! ``` //! ```
#![crate_name = "green"] #![crate_name = "green"]