Struct ZArr 

pub struct ZArr { /* private fields */ }

Wrapper of zend_array.

Implementations

impl ZArr

pub unsafe fn from_ptr<'a>(ptr: *const zend_array) -> &'a Self

Wraps a raw pointer.

Safety

Create from raw pointer.

Panics

Panics if pointer is null.

pub unsafe fn try_from_ptr<'a>(ptr: *const zend_array) -> Option<&'a Self>

Wraps a raw pointer, return None if pointer is null.

Safety

Create from raw pointer.

pub unsafe fn from_mut_ptr<'a>(ptr: *mut zend_array) -> &'a mut Self

Wraps a raw pointer.

Safety

Create from raw pointer.

Panics

Panics if pointer is null.

pub unsafe fn try_from_mut_ptr<'a>(ptr: *mut zend_array) -> Option<&'a mut Self>

Wraps a raw pointer, return None if pointer is null.

Safety

Create from raw pointer.

pub const fn as_ptr(&self) -> *const zend_array

Returns a raw pointer wrapped.

pub fn as_mut_ptr(&mut self) -> *mut zend_array

Returns a raw pointer wrapped.

pub fn is_empty(&mut self) -> bool

Returns true if the array has a length of 0.

pub fn len(&mut self) -> usize

Get array items length.

pub fn insert<'a>( &mut self, key: impl Into<InsertKey<'a>>, value: impl Into<ZVal>, )

Add or update item by key.

Notice that phper prefer to use Symtables api zend_symtable_*, so insert(42) and insert("42") should be considered the same.

pub fn get<'a>(&self, key: impl Into<Key<'a>>) -> Option<&'a ZVal>

Get item by key.

Notice that phper prefer to use Symtables api zend_symtable_*, so get(42) and get("42") should be considered the same.

pub fn get_mut<'a>(&mut self, key: impl Into<Key<'a>>) -> Option<&'a mut ZVal>

Get item by key.

Notice that phper prefer to use Symtables api zend_symtable_*, so get_mut(42) and get_mut("42") should be considered the same.

pub fn exists<'a>(&self, key: impl Into<Key<'a>>) -> bool

Check if the key exists.

Notice that phper prefer to use Symtables api zend_symtable_*, so exists(42) and exists("42") should be considered the same.

pub fn remove<'a>(&mut self, key: impl Into<Key<'a>>) -> bool

Remove the item under the key

Notice that phper prefer to use Symtables api zend_symtable_*, so remove(42) and remove("42") should be considered the same.

pub fn entry<'a>(&'a mut self, key: impl Into<Key<'a>>) -> Entry<'a>

Gets the given key’s corresponding entry in the array for in-place manipulation.

Examples

use phper::arrays::ZArray;

let mut arr = ZArray::new();

// count the number of occurrences of letters in the vec
for x in ["a", "b", "a", "c", "a", "b"] {
    arr.entry(x)
        .and_modify(|cur| *cur.as_mut_long().unwrap() += 1)
        .or_insert(1);
}

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

Provides a forward iterator.

pub fn iter_mut(&mut self) -> IterMut<'_>

Provides a forward iterator with mutable references.

Trait Implementations

impl Debug for ZArr

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

Formats the value using the given formatter.

impl Drop for ZArr

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a> FromZVal<'a> for &'a ZArr

fn expect(val: &'a ZVal) -> Result<Self>

Converts from ZVal, return ExpectTypeError when type mismatch.

impl<'a> FromZValMut<'a> for &'a mut ZArr

fn expect(val: &'a mut ZVal) -> Result<Self>

Converts from mutable ZVal, return ExpectTypeError when type mismatch.

impl ToOwned for ZArr

type Owned = EBox<ZArr>

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)

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

impl ToRefOwned for ZArr

type Owned = EBox<ZArr>

The resulting type after obtaining ownership.

fn to_ref_owned(&mut self) -> Self::Owned

Creates owned data from borrowed data, by increasing refcount.