Trait FromZvalMut 

pub trait FromZvalMut<'a>: Sized {
    const TYPE: DataType;
    const NULLABLE: bool = false;
    const BY_REF: bool = false;

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

    // Provided method
    fn from_missing() -> Option<Self> { ... }
}

Allows mutable zvals to be converted into Rust types in a fallible way.

If Self does not require the zval to be mutable to be extracted, you should implement FromZval instead, as this trait is generically implemented for any type that implements FromZval.

Required Associated Constants

const TYPE: DataType

The corresponding type of the implemented value in PHP.

Provided Associated Constants

const NULLABLE: bool = false

Whether a PHP argument of this type accepts null and may be omitted.

const BY_REF: bool = false

Whether a PHP argument of this type is declared pass-by-reference (&$arg). Set it for types that mutate a PHP value in place, so the engine separates the value before the call.

Required Methods

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

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

Parameters

• zval - Zval to get value from.

Provided Methods

fn from_missing() -> Option<Self>

The value to use when a PHP argument of this type was omitted by the caller. None means the argument is required.

It must return Some exactly when NULLABLE is true. The macros decide from NULLABLE alone which parameters PHP callers may omit.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl<'a> FromZvalMut<'a> for Option<&'a mut ZendHashTable>

const TYPE: DataType = DataType::Array

const NULLABLE: bool = true

const BY_REF: bool = true

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

fn from_missing() -> Option<Self>

Implementors

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

const TYPE: DataType

impl<'a, T> FromZvalMut<'a> for T

where T: FromZval<'a>,

const TYPE: DataType = <T as FromZval>::TYPE

const NULLABLE: bool = <T as FromZval>::NULLABLE

impl<'a> FromZvalMut<'a> for &'a mut Closure

Available on crate feature closure only.

const TYPE: DataType

impl<'a> FromZvalMut<'a> for &'a mut ZendHashTable

const TYPE: DataType = DataType::Array

const BY_REF: bool = true

impl<'a> FromZvalMut<'a> for &'a mut ZendIterator

const TYPE: DataType

impl<'a> FromZvalMut<'a> for &'a mut ZendObject

const TYPE: DataType = DataType::ANY_OBJECT

impl<'a> FromZvalMut<'a> for &'a mut Zval

const TYPE: DataType = DataType::Mixed

const BY_REF: bool = true

impl<'a> FromZvalMut<'a> for Iterable<'a>

const TYPE: DataType = DataType::Iterable

impl<'a> FromZvalMut<'a> for PhpRef<'a>

const TYPE: DataType = DataType::Mixed

const BY_REF: bool = true

impl<'a> FromZvalMut<'a> for Separated<'a>

const TYPE: DataType = DataType::Mixed