Struct ext_php_rs::types::ZendClassObject

#[repr(C)]
pub struct ZendClassObject<T> {
    pub obj: Option<T>,
    pub std: ZendObject,
}

Representation of a Zend class object in memory.

Fields

obj: Option<T>

std: ZendObject

Implementations

impl<T: RegisteredClass> ZendClassObject<T>

pub fn new(val: T) -> ZBox<Self>

Creates a new ZendClassObject of type T, where T is a RegisteredClass in PHP, storing the given value val inside the object.

Parameters

• val - The value to store inside the object.

Panics

Panics if memory was unable to be allocated for the new object.

pub unsafe fn new_uninit() -> ZBox<Self>

Creates a new ZendClassObject of type T, with an uninitialized internal object.

Safety

As the object is uninitialized, the caller must ensure the following until the internal object is initialized:

• The object is never dereferenced to T.
• The Clone implementation is never called.
• The Debug implementation is never called.

If any of these conditions are not met while not initialized, the corresponding function will panic. Converting the object into its inner pointer with the into_raw function is valid, however.

Panics

Panics if memory was unable to be allocated for the new object.

pub fn initialize(&mut self, val: T) -> Option<T>

Initializes the class object with the value val.

Parameters

• val - The value to initialize the object with.

Returns

Returns the old value in an Option if the object had already been initialized, None otherwise.

pub fn from_zend_obj(std: &zend_object) -> Option<&Self>

Returns a mutable reference to the ZendClassObject of a given zend object obj. Returns None if the given object is not of the type T.

Parameters

• obj - The zend object to get the ZendClassObject for.

pub fn from_zend_obj_mut(std: &mut zend_object) -> Option<&mut Self>

Returns a mutable reference to the ZendClassObject of a given zend object obj. Returns None if the given object is not of the type T.

Parameters

• obj - The zend object to get the ZendClassObject for.

pub fn get_mut_zend_obj(&mut self) -> &mut zend_object

Returns a mutable reference to the underlying Zend object.

Trait Implementations

impl<T: Debug> Debug for ZendClassObject<T>

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

Formats the value using the given formatter.

impl<T> Deref for ZendClassObject<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for ZendClassObject<T>

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

Mutably dereferences the value.

impl<'a, T: RegisteredClass> FromZendObject<'a> for &'a ZendClassObject<T>

fn from_zend_object(obj: &'a ZendObject) -> Result<Self>

Extracts Self from the source ZendObject.

impl<'a, T: RegisteredClass> FromZendObjectMut<'a> for &'a mut ZendClassObject<T>

fn from_zend_object_mut(obj: &'a mut ZendObject) -> Result<Self>

Extracts Self from the source ZendObject.

impl<'a, T: RegisteredClass> FromZval<'a> for &'a ZendClassObject<T>

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<'a, T: RegisteredClass> FromZvalMut<'a> for &'a mut ZendClassObject<T>

const TYPE: DataType

The corresponding type of the implemented value in PHP.

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

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

impl<T: RegisteredClass> IntoZval for &mut ZendClassObject<T>

const TYPE: DataType

The corresponding type of the implemented value in PHP.

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> ZBoxable for ZendClassObject<T>

fn free(&mut self)

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