Struct ZBox 

pub struct ZBox<T: ZBoxable>(/* private fields */);

A pointer type for heap allocation using the Zend memory manager.

See the module level documentation for more.

Implementations

impl<T: ZBoxable> ZBox<T>

pub unsafe fn from_raw(ptr: *mut T) -> Self

Creates a new box from a given pointer.

Parameters

• ptr - A non-null, well-aligned pointer to a T.

Safety

Caller must ensure that ptr is non-null, well-aligned and pointing to a T.

pub fn into_raw(self) -> *mut T

Returns the pointer contained by the box, dropping the box in the process. The data pointed to by the returned pointer is not released.

Mirrors Box::into_raw: the pointer is non-null and well-aligned, and the caller becomes responsible for releasing it, typically by passing it back to ZBox::from_raw or to the engine.

Trait Implementations

impl<T: ZBoxable> AsRef<T> for ZBox<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ZBoxable> Borrow<T> for ZBox<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl Clone for ZBox<ZendHashTable>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: RegisteredClass + Clone> Clone for ZBox<ZendClassObject<T>>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ZBoxable + Debug> Debug for ZBox<T>

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

Formats the value using the given formatter.

impl Default for ZBox<ZendHashTable>

fn default() -> Self

Returns the “default value” for a type.

impl<T: RegisteredClass + Default> Default for ZBox<ZendClassObject<T>>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ZBoxable> Deref for ZBox<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ZBoxable> DerefMut for ZBox<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ZBoxable> Drop for ZBox<T>

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> From<&'a ZBox<_zend_string>> for ArrayKey<'a>

fn from(value: &'a ZBox<ZendStr>) -> Self

Converts to this type from the input type.

impl From<&CStr> for ZBox<ZendStr>

fn from(value: &CStr) -> Self

Converts to this type from the input type.

impl From<&str> for ZBox<ZendStr>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<CString> for ZBox<ZendStr>

fn from(value: CString) -> Self

Converts to this type from the input type.

impl From<Cow<'_, _zend_string>> for ZBox<ZendStr>

fn from(value: Cow<'_, ZendStr>) -> Self

Converts to this type from the input type.

impl From<String> for ZBox<ZendStr>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T: RegisteredClass> From<ZBox<ZendClassObject<T>>> for ZBox<ZendObject>

fn from(obj: ZBox<ZendClassObject<T>>) -> Self

Converts to this type from the input type.

impl From<ZBox<_zend_string>> for Cow<'_, ZendStr>

fn from(value: ZBox<ZendStr>) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<(&'a str, _zval_struct)> for ZBox<ZendHashTable>

fn from_iter<T: IntoIterator<Item = (&'a str, Zval)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(i64, _zval_struct)> for ZBox<ZendHashTable>

fn from_iter<T: IntoIterator<Item = (i64, Zval)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<_zval_struct> for ZBox<ZendHashTable>

fn from_iter<T: IntoIterator<Item = Zval>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoZval for ZBox<ZendHashTable>

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, _: 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<T: RegisteredClass> IntoZval for ZBox<ZendClassObject<T>>

const TYPE: DataType

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, _: 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 IntoZval for ZBox<ZendObject>

const TYPE: DataType = DataType::ANY_OBJECT

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, _: 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<'a, K, V> TryFrom<BTreeMap<K, V>> for ZBox<ZendHashTable>

where K: Into<ArrayKey<'a>>, V: IntoZval,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BTreeMap<K, V>) -> Result<Self>

Performs the conversion.

impl<V> TryFrom<BTreeSet<V>> for ZBox<ZendHashTable>

where V: IntoZval,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BTreeSet<V>) -> Result<Self>

Performs the conversion.

impl<'a, K, V, H> TryFrom<HashMap<K, V, H>> for ZBox<ZendHashTable>

where K: Into<ArrayKey<'a>>, V: IntoZval, H: BuildHasher + Default,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: HashMap<K, V, H>) -> Result<Self>

Performs the conversion.

impl<V, H> TryFrom<HashSet<V, H>> for ZBox<ZendHashTable>

where V: IntoZval, H: BuildHasher,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: HashSet<V, H>) -> Result<Self>

Performs the conversion.

impl<'a, K, V, H> TryFrom<IndexMap<K, V, H>> for ZBox<ZendHashTable>

where K: Into<ArrayKey<'a>>, V: IntoZval, H: BuildHasher + Default,

Available on crate feature indexmap only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IndexMap<K, V, H>) -> Result<Self>

Performs the conversion.

impl<V, H> TryFrom<IndexSet<V, H>> for ZBox<ZendHashTable>

where V: IntoZval, H: BuildHasher,

Available on crate feature indexmap only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IndexSet<V, H>) -> Result<Self>

Performs the conversion.

impl<'a, K, V> TryFrom<Vec<(K, V)>> for ZBox<ZendHashTable>

where K: Into<ArrayKey<'a>>, V: IntoZval,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<(K, V)>) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<Vec<T>> for ZBox<ZendHashTable>

where T: IntoZval,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<T>) -> Result<Self>

Performs the conversion.