Struct ext_php_rs::bindings::_zend_array

#[repr(C)]
pub struct _zend_array {
    pub gc: zend_refcounted_h,
    pub u: _zend_array__bindgen_ty_1,
    pub nTableMask: u32,
    pub arData: *mut Bucket,
    pub nNumUsed: u32,
    pub nNumOfElements: u32,
    pub nTableSize: u32,
    pub nInternalPointer: u32,
    pub nNextFreeElement: zend_long,
    pub pDestructor: dtor_func_t,
}

Fields

gc: zend_refcounted_h

u: _zend_array__bindgen_ty_1

nTableMask: u32

arData: *mut Bucket

nNumUsed: u32

nNumOfElements: u32

nTableSize: u32

nInternalPointer: u32

nNextFreeElement: zend_long

pDestructor: dtor_func_t

Implementations

impl _zend_array

pub fn new() -> ZBox<Self>

Creates a new, empty, PHP associative array.

pub fn with_capacity(size: u32) -> ZBox<Self>

Creates a new, empty, PHP associative array with an initial size.

Parameters

• size - The size to initialize the array with.

pub fn len(&self) -> usize

Returns the current number of elements in the array.

pub fn is_empty(&self) -> bool

Returns whether the hash table is empty.

pub fn clear(&mut self)

Clears the hash table, removing all values.

pub fn get(&self, key: &str) -> Option<&Zval>

Attempts to retrieve a value from the hash table with a string key.

Parameters

• key - The key to search for in the hash table.

Returns

• Some(&Zval) - A reference to the zval at the position in the hash table.
• None - No value at the given position was found.

pub fn get_index(&self, key: u64) -> Option<&Zval>

Attempts to retrieve a value from the hash table with an index.

Parameters

• key - The key to search for in the hash table.

Returns

• Some(&Zval) - A reference to the zval at the position in the hash table.
• None - No value at the given position was found.

pub fn remove<K>(&mut self, key: &str) -> Option<()>

Attempts to remove a value from the hash table with a string key.

Parameters

• key - The key to remove from the hash table.

Returns

• Some(()) - Key was successfully removed.
• None - No key was removed, did not exist.

pub fn remove_index(&mut self, key: u64) -> Option<()>

Attempts to remove a value from the hash table with a string key.

Parameters

• key - The key to remove from the hash table.

Returns

• Ok(()) - Key was successfully removed.
• None - No key was removed, did not exist.

pub fn insert<V>(&mut self, key: &str, val: V) -> Result<()> where
    V: IntoZval, 

Attempts to insert an item into the hash table, or update if the key already exists. Returns nothing in a result if successful.

Parameters

• key - The key to insert the value at in the hash table.
• value - The value to insert into the hash table.

pub fn insert_at_index<V>(&mut self, key: u64, val: V) -> Result<()> where
    V: IntoZval, 

Inserts an item into the hash table at a specified index, or updates if the key already exists. Returns nothing in a result if successful.

Parameters

• key - The index at which the value should be inserted.
• val - The value to insert into the hash table.

pub fn push<V>(&mut self, val: V) -> Result<()> where
    V: IntoZval, 

Pushes an item onto the end of the hash table. Returns a result containing nothing if the element was sucessfully inserted.

Parameters

• val - The value to insert into the hash table.

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

Returns an iterator over the key(s) and value contained inside the hashtable.

pub fn values(&self) -> Values<'_>

Returns an iterator over the values contained inside the hashtable, as if it was a set or list.

Trait Implementations

impl<V> TryFrom<&'_ _zend_array> for HashMap<String, V> where
    for<'a> V: FromZval<'a>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &HashTable) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<&'_ _zend_array> for Vec<T> where
    for<'a> T: FromZval<'a>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &HashTable) -> Result<Self>

Performs the conversion.