Type Alias ZendIterator 

pub type ZendIterator = zend_object_iterator;

A PHP Iterator.

In PHP, iterators are represented as zend_object_iterator. This allows user to iterate over objects implementing Traversable interface using foreach.

Use Iterable to iterate over both iterators and arrays.

Aliased Type

#[repr(C)]
pub struct ZendIterator {
    pub std: _zend_object,
    pub data: _zval_struct,
    pub funcs: *const _zend_object_iterator_funcs,
    pub index: u64,
}

Fields

std: _zend_object

data: _zval_struct

funcs: *const _zend_object_iterator_funcs

index: u64

Implementations

impl ZendIterator

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

Creates a new rust iterator from a zend_object_iterator.

Returns a iterator over the zend_object_iterator, or None if the iterator cannot be rewound.

pub fn valid(&mut self) -> bool

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

pub fn rewind(&mut self) -> bool

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

Returns

Returns true if the iterator was successfully rewind, false otherwise. (when there is an exception during rewind)

pub fn move_forward(&mut self) -> bool

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

Returns

Returns true if the iterator was successfully move, false otherwise. (when there is an exception during next)

pub fn get_current_data(&mut self) -> Option<&Zval>

Get the current data of the iterator.

The reference borrows the iterator: Zend owns the returned zval and releases it on the next move_forward, rewind or when the iterator is destroyed (zend_user_it_invalidate_current calls zval_ptr_dtor on it). Use Zval::shallow_clone to keep the value across iterations.

Returns

Returns a reference to the current data of the iterator if available , None otherwise.

pub fn get_current_key(&mut self) -> Option<Zval>

Get the current key of the iterator.

Returns

Returns a new Zval containing the current key of the iterator if available , None otherwise.

Trait Implementations

impl Debug for ZendIterator

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

Formats the value using the given formatter.

impl<'a> FromZvalMut<'a> for &'a mut ZendIterator

const TYPE: DataType

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 ZendIterator

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.