Struct ext_php_rs::bindings::_zend_string

#[repr(C)]
pub struct _zend_string {
    pub gc: zend_refcounted_h,
    pub h: zend_ulong,
    pub len: size_t,
    pub val: [c_char; 1],
}

Fields

gc: zend_refcounted_h

h: zend_ulong

len: size_t

val: [c_char; 1]

Implementations

impl _zend_string

pub fn new(str: &str, persistent: bool) -> Result<ZBox<Self>>

Creates a new Zend string from a str.

Parameters

• str - String content.
• persistent - Whether the string should persist through the request boundary.

Returns

Returns a result containing the Zend string if successful. Returns an error if the given string contains NUL bytes, which cannot be contained inside a C string.

Panics

Panics if the function was unable to allocate memory for the Zend string.

pub fn from_c_str(str: &CStr, persistent: bool) -> ZBox<Self>

Creates a new Zend string from a CStr.

Parameters

• str - String content.
• persistent - Whether the string should persist through the request boundary.

Panics

Panics if the function was unable to allocate memory for the Zend string.

pub fn new_interned(str: &str, persistent: bool) -> Result<ZBox<Self>>

Creates a new interned Zend string from a str.

An interned string is only ever stored once and is immutable. PHP stores the string in an internal hashtable which stores the interned strings.

As Zend hashtables are not thread-safe, a mutex is used to prevent two interned strings from being created at the same time.

Parameters

• str - String content.
• persistent - Whether the string should persist through the request boundary.

Returns

Returns a result containing the Zend string if successful. Returns an error if the given string contains NUL bytes, which cannot be contained inside a C string.

Panics

Panics if the function was unable to allocate memory for the Zend string.

pub fn interned_from_c_str(str: &CStr, persistent: bool) -> ZBox<Self>

Creates a new interned Zend string from a CStr.

An interned string is only ever stored once and is immutable. PHP stores the string in an internal hashtable which stores the interned strings.

As Zend hashtables are not thread-safe, a mutex is used to prevent two interned strings from being created at the same time.

Parameters

• str - String content.
• persistent - Whether the string should persist through the request boundary.

Panics

Panics under the following circumstances:

• The function used to create interned strings has not been set.
• The function could not allocate enough memory for the Zend string.

pub fn len(&self) -> usize

Returns the length of the string.

pub fn is_empty(&self) -> bool

Returns true if the string is empty, false otherwise.

pub fn as_c_str(&self) -> &CStr

Returns a reference to the underlying CStr inside the Zend string.

pub fn as_str(&self) -> Option<&str>

Attempts to return a reference to the underlying str inside the Zend string.

Returns the None variant if the CStr contains non-UTF-8 characters.

Trait Implementations

impl<'a> From<&'a _zend_string> for &'a CStr

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

Performs the conversion.

impl<'a> From<&'a _zend_string> for Cow<'a, ZendStr>

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

Performs the conversion.

impl PartialEq<_zend_string> for ZendStr

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'a> TryFrom<&'_ _zend_string> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &ZendStr) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a _zend_string> for &'a str

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a ZendStr) -> Result<Self>

Performs the conversion.