1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
use std::convert::From;
use types::{Value, ValueType};
use {
AnyObject,
AnyException,
Array,
Class,
Fixnum,
Object,
VerifiedObject,
};
/// `Enumerator`
#[derive(Debug)]
#[repr(C)]
pub struct Enumerator {
value: Value,
}
impl Enumerator {
/// Advances the iterator and returns the next value.
///
/// Returns [`Err`] when iteration is finished.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
/// # VM::init();
///
/// let mut iter = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1)).to_enum();
///
/// // A call to next() returns the next value...
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), iter.next());
/// assert_eq!(Ok(Fixnum::new(1).to_any_object()), iter.next());
///
/// // ... and then Err once it's over.
/// assert!(iter.next().is_err(), "not error!");
///
/// // More calls will always return Err.
/// assert!(iter.next().is_err(), "not error!");
/// assert!(iter.next().is_err(), "not error!");
/// ```
pub fn next(&mut self) -> Result<AnyObject, AnyException> {
self.protect_send("next", &[])
}
/// Advances the iterator and returns the next values.
///
/// Returns [`Err`] when iteration is finished.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
/// # VM::init();
///
/// let mut array = Array::with_capacity(2);
///
/// array.push(Fixnum::new(1));
/// array.push(Fixnum::new(2));
///
/// let mut iter = array.to_enum();
///
/// // A call to next_values() returns the next values...
/// let mut result1 = Array::with_capacity(1);
/// result1.push(Fixnum::new(1));
/// assert_eq!(Ok(result1), iter.next_values());
/// let mut result2 = Array::with_capacity(1);
/// result2.push(Fixnum::new(2));
/// assert_eq!(Ok(result2), iter.next_values());
///
/// // ... and then Err once it's over.
/// assert!(iter.next_values().is_err(), "not error!");
///
/// // More calls will always retirn Err.
/// assert!(iter.next_values().is_err(), "not error!");
/// assert!(iter.next_values().is_err(), "not error!");
/// ```
pub fn next_values(&mut self) -> Result<Array, AnyException> {
self.protect_send("next_values", &[])
.map(|v| Array::from(v.value()))
}
/// Peeks into the iterator and returns the next value.
///
/// Returns [`Err`] when iteration is finished.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
/// # VM::init();
///
/// let mut iter = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1)).to_enum();
///
/// // A call to peek() returns the next value without progressing the iteration
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), iter.peek());
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), iter.peek());
/// ```
pub fn peek(&self) -> Result<AnyObject, AnyException> {
self.protect_send("peek", &[])
}
/// Peeks into the iterator and returns the next values.
///
/// Returns [`Err`] when iteration is finished.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
/// # VM::init();
///
/// let mut array = Array::with_capacity(2);
///
/// array.push(Fixnum::new(1));
/// array.push(Fixnum::new(2));
///
/// let mut iter = array.to_enum();
///
/// // A call to peek_values() returns the next values without progressing the iteration
/// let mut result1 = Array::with_capacity(1);
/// result1.push(Fixnum::new(1));
/// assert_eq!(Ok(result1.dup()), iter.peek_values());
/// assert_eq!(Ok(result1), iter.peek_values());
/// ```
pub fn peek_values(&self) -> Result<Array, AnyException> {
self.protect_send("peek_values", &[])
.map(|v| Array::from(v.value()))
}
/// Rewind the iteration back to the beginning.
///
/// Returns [`Err`] when iteration is finished.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
/// # VM::init();
///
/// let mut iter = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1)).to_enum();
///
/// // A call to next() returns the next value...
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), iter.next());
/// assert_eq!(Ok(Fixnum::new(1).to_any_object()), iter.next());
/// assert!(iter.next().is_err(), "not error!");
///
/// iter.rewind();
///
/// // A call to next() returns the next value...
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), iter.next());
/// assert_eq!(Ok(Fixnum::new(1).to_any_object()), iter.next());
/// assert!(iter.next().is_err(), "not error!");
/// ```
pub fn rewind(&mut self) -> &mut Self {
unsafe { self.send("rewind", &[]) };
self
}
/// Feed a return value back in to internal yield inside enumerator.
///
/// # Examples
///
/// ```
/// use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator, Class};
/// # VM::init();
///
/// let mut e_iter = VM::eval("[1,2,3].map").unwrap().
/// try_convert_to::<Enumerator>().unwrap();
///
/// assert_eq!(Ok(Fixnum::new(1).to_any_object()), e_iter.next());
/// e_iter.feed(Fixnum::new(999).to_any_object());
/// assert_eq!(Ok(Fixnum::new(2).to_any_object()), e_iter.next());
/// e_iter.feed(Fixnum::new(888).to_any_object());
/// assert_eq!(Ok(Fixnum::new(3).to_any_object()), e_iter.next());
/// e_iter.feed(Fixnum::new(777).to_any_object());
///
/// match e_iter.next() {
/// Ok(_) => unreachable!(),
/// Err(e) => {
/// let mut expected = Array::with_capacity(3);
/// expected.push(Fixnum::new(999).to_any_object());
/// expected.push(Fixnum::new(888).to_any_object());
/// expected.push(Fixnum::new(777).to_any_object());
///
/// assert!(Class::from_existing("StopIteration").case_equals(&e));
/// assert_eq!(expected.to_any_object(), unsafe { e.send("result", &[]) });
/// },
/// }
/// ```
///
/// Ruby:
///
/// ```ruby
/// e = [1,2,3].map
/// p e.next #=> 1
/// e.feed 999
/// p e.next #=> 2
/// e.feed 888
/// p e.next #=> 3
/// e.feed 777
/// begin
/// e.next
/// rescue StopIteration
/// p $!.result #=> [999, 888, 777]
/// end
/// ```
pub fn feed(&mut self, object: AnyObject) -> Result<(), AnyException> {
self.protect_send("feed", &[object]).map(|_| ())
}
}
impl From<Value> for Enumerator {
fn from(value: Value) -> Self {
Enumerator { value: value }
}
}
impl Into<Value> for Enumerator {
fn into(self) -> Value {
self.value
}
}
impl Into<AnyObject> for Enumerator {
fn into(self) -> AnyObject {
AnyObject::from(self.value)
}
}
impl Object for Enumerator {
#[inline]
fn value(&self) -> Value {
self.value
}
}
impl VerifiedObject for Enumerator {
fn is_correct_type<T: Object>(object: &T) -> bool {
Class::from_existing("Enumerator").case_equals(object)
}
fn error_message() -> &'static str {
"Error converting to Enumerator"
}
}
impl PartialEq for Enumerator {
fn eq(&self, other: &Self) -> bool {
self.equals(other)
}
}