From b5dd25888496d45f38ccae936fe2baee950c30f9 Mon Sep 17 00:00:00 2001 From: Robert Clipsham Date: Thu, 10 Jul 2014 15:12:00 +0100 Subject: [PATCH] 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. --- src/libgreen/lib.rs | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/libgreen/lib.rs b/src/libgreen/lib.rs index 3574f415815d7..d7661e7d3e6d9 100644 --- a/src/libgreen/lib.rs +++ b/src/libgreen/lib.rs @@ -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"]