Struct ZendEmptyArray 

pub struct ZendEmptyArray;

Represents an empty, immutable, shared PHP array.

Since PHP 7.3, it’s possible for extensions to return a zval backed by an immutable shared hashtable. This helps avoid redundant hashtable allocations when returning empty arrays to userland PHP code.

This struct provides a safe way to return an empty array without allocating a new hashtable. It implements IntoZval so it can be used as a return type for PHP functions.

Safety

Unlike ZendHashTable, this type does not allow any mutation of the underlying array, as it points to a shared static empty array in PHP’s memory.

Example

use ext_php_rs::prelude::*;
use ext_php_rs::types::ZendEmptyArray;

#[php_function]
pub fn get_empty_array() -> ZendEmptyArray {
    ZendEmptyArray
}

This is more efficient than returning Vec::<i32>::new() or creating a new ZendHashTable when you know the result will be empty.

Implementations

impl ZendEmptyArray

pub fn as_hashtable(&self) -> &ZendHashTable

Returns a reference to the underlying immutable empty hashtable.

Example

use ext_php_rs::types::ZendEmptyArray;

let empty = ZendEmptyArray;
let ht = empty.as_hashtable();
assert!(ht.is_empty());
assert!(ht.is_immutable());

Trait Implementations

impl Clone for ZendEmptyArray

fn clone(&self) -> ZendEmptyArray

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZendEmptyArray

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

Formats the value using the given formatter.

impl Default for ZendEmptyArray

fn default() -> ZendEmptyArray

Returns the “default value” for a type.

impl IntoZval for ZendEmptyArray

const TYPE: DataType = DataType::Array

The corresponding type of the implemented value in PHP.

const NULLABLE: bool = false

Whether converting into a Zval may result in null.

fn set_zval(self, zv: &mut Zval, _persistent: bool) -> Result<()>

Sets the content of a pre-existing zval. Returns a result containing nothing if setting the content was successful.

fn into_zval(self, persistent: bool) -> Result<Zval>

Converts a Rust primitive type into a Zval. Returns a result containing the Zval if successful.

impl Copy for ZendEmptyArray