Cleanup

Author: danog

guide/src/types/iterator.md

@@ -11,6 +11,8 @@ the variable. This means that any value, at the exception of an `array`, that ca
 a `foreach` loop can be converted into a `ZendIterator`. As an example, a `Generator` can be
 used but also a the result of a `query` call with `PDO`.
 
+If you want a more universal `iterable` type that also supports arrays, see [Iterable](./iterable.md).  
+
 ## Rust example
 
 ```rust,no_run

src/flags.rs

@@ -8,11 +8,10 @@ use crate::ffi::{
     CONST_CS, CONST_DEPRECATED, CONST_NO_FILE_CACHE, CONST_PERSISTENT, E_COMPILE_ERROR,
     E_COMPILE_WARNING, E_CORE_ERROR, E_CORE_WARNING, E_DEPRECATED, E_ERROR, E_NOTICE, E_PARSE,
     E_RECOVERABLE_ERROR, E_STRICT, E_USER_DEPRECATED, E_USER_ERROR, E_USER_NOTICE, E_USER_WARNING,
-    E_WARNING, IS_ARRAY, IS_CALLABLE, IS_CONSTANT_AST, IS_DOUBLE, IS_FALSE, IS_INDIRECT, IS_LONG,
-    IS_ITERABLE, 
-    IS_MIXED, IS_NULL, IS_OBJECT, IS_PTR, IS_REFERENCE, IS_RESOURCE, IS_STRING, IS_TRUE,
-    IS_TYPE_COLLECTABLE, IS_TYPE_REFCOUNTED, IS_UNDEF, IS_VOID, PHP_INI_ALL, PHP_INI_PERDIR,
-    PHP_INI_SYSTEM, PHP_INI_USER, ZEND_ACC_ABSTRACT, ZEND_ACC_ANON_CLASS,
+    E_WARNING, IS_ARRAY, IS_CALLABLE, IS_CONSTANT_AST, IS_DOUBLE, IS_FALSE, IS_INDIRECT,
+    IS_ITERABLE, IS_LONG, IS_MIXED, IS_NULL, IS_OBJECT, IS_PTR, IS_REFERENCE, IS_RESOURCE,
+    IS_STRING, IS_TRUE, IS_TYPE_COLLECTABLE, IS_TYPE_REFCOUNTED, IS_UNDEF, IS_VOID, PHP_INI_ALL,
+    PHP_INI_PERDIR, PHP_INI_SYSTEM, PHP_INI_USER, ZEND_ACC_ABSTRACT, ZEND_ACC_ANON_CLASS,
     ZEND_ACC_CALL_VIA_TRAMPOLINE, ZEND_ACC_CHANGED, ZEND_ACC_CLOSURE, ZEND_ACC_CONSTANTS_UPDATED,
     ZEND_ACC_CTOR, ZEND_ACC_DEPRECATED, ZEND_ACC_DONE_PASS_TWO, ZEND_ACC_EARLY_BINDING,
     ZEND_ACC_FAKE_CLOSURE, ZEND_ACC_FINAL, ZEND_ACC_GENERATOR, ZEND_ACC_HAS_FINALLY_BLOCK,

src/types/iterable.rs

@@ -5,8 +5,8 @@ use crate::flags::DataType;
 use crate::types::iterator::IterKey;
 use crate::types::{ZendHashTable, ZendIterator, Zval};
 
-/// This type represents a PHP iterable, which can be either an array or an object implementing
-/// the Traversable interface.
+/// This type represents a PHP iterable, which can be either an array or an
+/// object implementing the Traversable interface.
 #[derive(Debug)]
 pub enum Iterable<'a> {
     Array(&'a ZendHashTable),

src/types/iterator.rs

@@ -7,8 +7,8 @@ use std::fmt::{Debug, Display, Formatter};
 
 /// A PHP Iterator.
 ///
-/// In PHP, iterators are represented as zend_object_iterator. This allow user to iterate
-/// over object implementing Traversable interface using foreach.
+/// In PHP, iterators are represented as zend_object_iterator. This allow user
+/// to iterate over object implementing Traversable interface using foreach.
 pub type ZendIterator = zend_object_iterator;
 
 impl ZendIterator {
@@ -29,8 +29,8 @@ impl ZendIterator {
 
     /// Check if the current position of the iterator is valid.
     ///
-    /// As an example this will call the user defined valid method of the ['\Iterator'] interface.
-    /// see <https://www.php.net/manual/en/iterator.valid.php>
+    /// As an example this will call the user defined valid method of the
+    /// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.valid.php>
     pub fn valid(&mut self) -> bool {
         if let Some(valid) = unsafe { (*self.funcs).valid } {
             let valid = unsafe { valid(&mut *self) == ZEND_RESULT_CODE_SUCCESS };
@@ -47,13 +47,13 @@ impl ZendIterator {
 
     /// Rewind the iterator to the first element.
     ///
-    /// As an example this will call the user defined rewind method of the ['\Iterator'] interface.
-    /// see <https://www.php.net/manual/en/iterator.rewind.php>
+    /// As an example this will call the user defined rewind method of the
+    /// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.rewind.php>
     ///
     /// # Returns
     ///
-    /// Returns true if the iterator was successfully rewind, false otherwise. (when there is
-    /// an exception during rewind)
+    /// Returns true if the iterator was successfully rewind, false otherwise.
+    /// (when there is an exception during rewind)
     pub fn rewind(&mut self) -> bool {
         if let Some(rewind) = unsafe { (*self.funcs).rewind } {
             unsafe {
@@ -66,13 +66,13 @@ impl ZendIterator {
 
     /// Move the iterator forward to the next element.
     ///
-    /// As an example this will call the user defined next method of the ['\Iterator'] interface.
-    /// see <https://www.php.net/manual/en/iterator.next.php>
+    /// As an example this will call the user defined next method of the
+    /// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.next.php>
     ///
     /// # Returns
     ///
-    /// Returns true if the iterator was successfully move, false otherwise. (when there is
-    /// an exception during next)
+    /// Returns true if the iterator was successfully move, false otherwise.
+    /// (when there is an exception during next)
     pub fn move_forward(&mut self) -> bool {
         if let Some(move_forward) = unsafe { (*self.funcs).move_forward } {
             unsafe {
@@ -104,8 +104,8 @@ impl ZendIterator {
     ///
     /// # Returns
     ///
-    /// Returns a new ['Zval'] containing the current key of the iterator if available
-    /// , ['None'] otherwise.
+    /// Returns a new ['Zval'] containing the current key of the iterator if
+    /// available , ['None'] otherwise.
     pub fn get_current_key(&mut self) -> Option<Zval> {
         let get_current_key = unsafe { (*self.funcs).get_current_key? };
         let mut key = Zval::new();
@@ -178,7 +178,8 @@ impl<'a> Iterator for Iter<'a> {
     type Item = (IterKey, &'a Zval);
 
     fn next(&mut self) -> Option<Self::Item> {
-        // Call next when index > 0, so next is really called at the start of each iteration, which allow to work better with generator iterator
+        // Call next when index > 0, so next is really called at the start of each
+        // iteration, which allow to work better with generator iterator
         if self.zi.index > 0 && !self.zi.move_forward() {
             return None;
         }

src/types/zval.rs

@@ -267,7 +267,8 @@ impl Zval {
         }
     }
 
-    /// Returns an iterable over the zval if it is an array or traversable. (is iterable)
+    /// Returns an iterable over the zval if it is an array or traversable. (is
+    /// iterable)
     pub fn iterable(&self) -> Option<Iterable> {
         if self.is_iterable() {
             Iterable::from_zval(self)
@@ -399,7 +400,8 @@ impl Zval {
         }
     }
 
-    /// Returns true if the zval is iterable (array or traversable), false otherwise.
+    /// Returns true if the zval is iterable (array or traversable), false
+    /// otherwise.
     pub fn is_iterable(&self) -> bool {
         let ptr: *const Self = self;
         unsafe { zend_is_iterable(ptr as *mut Self) }