Enum ArrayKey 

pub enum ArrayKey<'a> {
    Long(i64),
    String(String),
    Str(&'a str),
    ZendString(&'a ZendStr),
}

Represents the key of a PHP array, which can be either a long or a string.

Variants

Long(i64)

A numerical key. In Zend API it’s represented by u64 (zend_ulong), so the value needs to be cast to zend_ulong before passing into Zend functions.

String(String)

A string key.

Str(&'a str)

A string key by reference.

ZendString(&'a ZendStr)

A PHP zend_string key. Allows bypassing repeated zend_string_init allocations and re-hashing when working with pre-existing or interned PHP strings

Implementations

impl ArrayKey<'_>

pub fn is_long(&self) -> bool

Check if the key is an integer.

Returns

Returns true if the key is an integer, false otherwise.

Trait Implementations

impl<'a> Clone for ArrayKey<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ArrayKey<'a>

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

Formats the value using the given formatter.

impl Display for ArrayKey<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for ArrayKey<'a>

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

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

Converts to this type from the input type.

impl<'a> From<&'a str> for ArrayKey<'a>

fn from(value: &'a str) -> ArrayKey<'a>

Converts to this type from the input type.

impl From<String> for ArrayKey<'_>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<'a> From<i32> for ArrayKey<'a>

fn from(index: i32) -> ArrayKey<'a>

Converts to this type from the input type.

impl<'a> From<i64> for ArrayKey<'a>

fn from(index: i64) -> ArrayKey<'a>

Converts to this type from the input type.

impl<'a> From<u64> for ArrayKey<'a>

fn from(index: u64) -> ArrayKey<'a>

Converts to this type from the input type.

impl<'a> From<usize> for ArrayKey<'a>

fn from(index: usize) -> ArrayKey<'a>

Converts to this type from the input type.

impl<'a> FromZval<'a> for ArrayKey<'_>

const TYPE: DataType = DataType::String

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.

const NULLABLE: bool = false

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

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.

impl<'a> Hash for ArrayKey<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ArrayKey<'a>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<'a> PartialEq for ArrayKey<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> PartialOrd for ArrayKey<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralPartialEq for ArrayKey<'a>

impl TryFrom<ArrayKey<'_>> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: ArrayKey<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ArrayKey<'_>> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: ArrayKey<'_>) -> Result<Self, Self::Error>

Performs the conversion.