Enum Iterable 

pub enum Iterable<'a> {
    Array(&'a ZendHashTable),
    Traversable(&'a mut ZendIterator),
}

This type represents a PHP iterable, which can be either an array or an object implementing the Traversable interface.

An Iterable can only be extracted from a mutable Zval, via FromZvalMut. Resolving the Traversable variant invokes the Zend get_iterator handler, which mutates the object, so a shared borrow is not enough:

use ext_php_rs::{convert::FromZvalMut, types::{Iterable, Zval}};

fn extract(zval: &Zval) -> Option<Iterable<'_>> {
    Iterable::from_zval_mut(zval)
}

Variants

Array(&'a ZendHashTable)

Iterable is an Array

Traversable(&'a mut ZendIterator)

Iterable is a Traversable

Implementations

impl Iterable<'_>

pub fn iter(&mut self) -> Option<Iter<'_>>

Creates a new rust iterator from a PHP iterable. May return None if a Traversable cannot be rewound.

Trait Implementations

impl<'a> Debug for Iterable<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> FromZvalMut<'a> for Iterable<'a>

const TYPE: DataType = DataType::Iterable

The corresponding type of the implemented value in PHP.

fn from_zval_mut(zval: &'a mut Zval) -> Option<Self>

Attempts to retrieve an instance of Self from a mutable reference to a Zval.

const NULLABLE: bool = false

Whether a PHP argument of this type accepts null and may be omitted.

const BY_REF: bool = false

Whether a PHP argument of this type is declared pass-by-reference (&$arg). Set it for types that mutate a PHP value in place, so the engine separates the value before the call.

fn from_missing() -> Option<Self>

The value to use when a PHP argument of this type was omitted by the caller. None means the argument is required.

impl<'a> IntoIterator for &'a mut Iterable<'a>

type Item = (_zval_struct, _zval_struct)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.