Type Definition ext_php_rs::bindings::HashTable

pub type HashTable = _zend_array;

Implementations

impl HashTable

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 Debug for HashTable

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

Formats the value using the given formatter.

impl<'a> FromZval<'a> for &'a HashTable

const TYPE: DataType

The corresponding type of the implemented value in PHP.

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

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

impl ToOwned for HashTable

type Owned = ZBox<HashTable>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning.

impl ZBoxable for HashTable

fn free(&mut self)

Frees the memory pointed to by self, calling any destructors required in the process.