Skip to content

Renamed generators to coroutines as per rust's updates #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "gen-iter"
version = "0.2.1"
version = "0.4.0"
authors = ["tinaun <tinagma@gmail.com>"]
keywords = ["generator", "iterator"]
description = "temporary util for creating iterators using generators"
Expand Down
1 change: 1 addition & 0 deletions rust-toolchain
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nightly
21 changes: 10 additions & 11 deletions src/gen_iter.rs
Original file line number Diff line number Diff line change
@@ -1,45 +1,44 @@
use core::ops::{Generator, GeneratorState};
use core::iter::Iterator;
use core::marker::Unpin;
use core::ops::{Coroutine, CoroutineState};
use core::pin::Pin;

/// an iterator that holds an internal generator representing
/// the iteration state
#[derive(Copy, Clone, Debug)]
pub struct GenIter<T>(pub T)
where
T: Generator<Return = ()> + Unpin;
T: Coroutine<Return = ()> + Unpin;

impl<T> Iterator for GenIter<T>
where
T: Generator<Return = ()> + Unpin,
T: Coroutine<Return = ()> + Unpin,
{
type Item = T::Yield;

#[inline]
fn next(&mut self) -> Option<Self::Item> {
match Pin::new(&mut self.0).resume(()) {
GeneratorState::Yielded(n) => Some(n),
GeneratorState::Complete(()) => None,
CoroutineState::Yielded(n) => Some(n),
CoroutineState::Complete(()) => None,
}
}
}

impl<G> From<G> for GenIter<G>
where
G: Generator<Return = ()> + Unpin,
G: Coroutine<Return = ()> + Unpin,
{
#[inline]
fn from(gen: G) -> Self {
GenIter(gen)
}
}


/// macro to simplify iterator - via - generator construction
///
/// ```
/// #![feature(generators)]
/// #![feature(coroutines)]
///
/// use gen_iter::gen_iter;
///
Expand All @@ -60,10 +59,9 @@ macro_rules! gen_iter {
};
(move $block: block) => {
$crate::GenIter(move || $block)
}
};
}


#[cfg(test)]
mod tests {
use super::GenIter;
Expand All @@ -85,7 +83,8 @@ mod tests {
let mut g: GenIter<_> = (|| {
yield 1;
yield 2;
}).into();
})
.into();

assert_eq!(g.next(), Some(1));
assert_eq!(g.next(), Some(2));
Expand Down
32 changes: 16 additions & 16 deletions src/gen_iter_return.rs
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
use core::ops::{Generator, GeneratorState};
use core::iter::{Iterator, FusedIterator};
use core::iter::{FusedIterator, Iterator};
use core::marker::Unpin;
use core::ops::{Coroutine, CoroutineState};
use core::pin::Pin;

/// `GenIterReturn<G>` holds a generator `G` or the return value of `G`,
/// `&mut GenIterReturn<G>` acts as an iterator.
///
///
/// Differences with `GenIter<G>`:
/// 1. able to get return value of a generator
/// 2. safe to call `next()` after generator is done without panic
/// 3. maybe less efficient than `GenIter<G>`
#[derive(Copy, Clone, Debug)]
pub struct GenIterReturn<G: Generator + Unpin>(Result<G::Return, G>);
pub struct GenIterReturn<G: Coroutine + Unpin>(Result<G::Return, G>);

impl<G: Generator + Unpin> GenIterReturn<G> {
impl<G: Coroutine + Unpin> GenIterReturn<G> {
#[inline]
pub fn new(g: G) -> Self {
GenIterReturn(Err(g))
Expand All @@ -37,34 +37,34 @@ impl<G: Generator + Unpin> GenIterReturn<G> {
/// in which return value cannot be got.
/// ```compile_fail
/// // !!INVALID CODE!!
/// # #![feature(generators)]
/// # #![feature(coroutines)]
/// # use gen_iter::gen_iter_return;
/// let mut g = gen_iter_return!({ yield 1; return "done"; });
/// for v in g {} // invalid, because `GenIterReturn<G>` is not `Iterator`
/// let ret = g.return_or_self(); // g is dropped after for loop
/// ```
impl<G: Generator + Unpin> Iterator for &mut GenIterReturn<G> {
impl<G: Coroutine + Unpin> Iterator for &mut GenIterReturn<G> {
type Item = G::Yield;

#[inline]
fn next(&mut self) -> Option<Self::Item> {
match self.0 {
Ok(_) => None,
Err(ref mut g) => match Pin::new(g).resume(()) {
GeneratorState::Yielded(y) => Some(y),
GeneratorState::Complete(r) => {
CoroutineState::Yielded(y) => Some(y),
CoroutineState::Complete(r) => {
self.0 = Ok(r);
None
},
}
}
},
}
}
}

/// `GenIterReturn<G>` satisfies the trait `FusedIterator`
impl<G: Generator + Unpin> FusedIterator for &mut GenIterReturn<G> {}
impl<G: Coroutine + Unpin> FusedIterator for &mut GenIterReturn<G> {}

impl<G: Generator + Unpin> From<G> for GenIterReturn<G> {
impl<G: Coroutine + Unpin> From<G> for GenIterReturn<G> {
#[inline]
fn from(g: G) -> Self {
GenIterReturn::new(g)
Expand All @@ -73,7 +73,7 @@ impl<G: Generator + Unpin> From<G> for GenIterReturn<G> {

/// macro to simplify iterator - via - generator with return value construction
/// ```
/// #![feature(generators)]
/// #![feature(coroutines)]
///
/// use gen_iter::gen_iter_return;
///
Expand All @@ -95,7 +95,7 @@ macro_rules! gen_iter_return {
};
(move $block: block) => {
$crate::GenIterReturn::new(move || $block)
}
};
}

#[cfg(test)]
Expand All @@ -116,7 +116,7 @@ mod tests {

g = match g.return_or_self() {
Ok(_) => panic!("generator is done but should not"),
Err(g) => g
Err(g) => g,
};

assert_eq!((&mut g).next(), None);
Expand Down
16 changes: 8 additions & 8 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
//! ## [`GenIter`] and [`gen_iter!`]
//! [`GenIter`] converts a [`Generator<(), Return=()>`](core::ops::Generator) into an iterator over the
//! yielded type of the generator. The return type of the generator needs to be `()`.
//!
//!
//! [`gen_iter!`] helps to create a [`GenIter`]
//!
//! ```
//! #![feature(generators)]
//! #![feature(coroutines)]
//!
//! use gen_iter::gen_iter;
//!
Expand All @@ -30,16 +30,16 @@
//! println!("{}", elem);
//! }
//! ```
//!
//!
//! ## [`GenIterReturn`] and [`gen_iter_return!`]
//! [`GenIterReturn`] can be converted from a [`Generator<()>`](core::ops::Generator),
//! `&mut GenIterReturn<G>` can be used as iterator.
//! The return value of the generator can be got after the iterator is exhausted.
//!
//!
//! [`gen_iter_return!`] helps to create a [`GenIterReturn`].
//!
//!
//! ```
//! #![feature(generators)]
//! #![feature(coroutines)]
//!
//! use gen_iter::gen_iter_return;
//!
Expand All @@ -48,7 +48,7 @@
//! yield 2;
//! return "done";
//! });
//!
//!
//! for y in &mut g {
//! println!("yield {}", y);
//! }
Expand All @@ -57,7 +57,7 @@
//! ```

#![no_std]
#![feature(generators, generator_trait)]
#![feature(coroutines, coroutine_trait)]

mod gen_iter;
pub use gen_iter::*;
Expand Down