Struct ext_php_rs::exception::PhpException

pub struct PhpException { /* private fields */ }

Represents a PHP exception which can be thrown using the throw() function. Primarily used to return from a Result<T, PhpException> which can immediately be thrown by the ext-php-rs macro API.

There are default From implementations for any type that implements ToString, so these can also be returned from these functions. You can also implement From<T> for your custom error type.

Implementations

impl PhpException

pub fn new(message: String, code: i32, ex: &'static ClassEntry) -> Self

Creates a new exception instance.

Parameters

• message - Message to contain in the exception.
• code - Integer code to go inside the exception.
• ex - Exception type to throw.

pub fn default(message: String) -> Self

Creates a new default exception instance, using the default PHP Exception type as the exception type, with an integer code of zero.

Parameters

• message - Message to contain in the exception.

pub fn from_class<T: RegisteredClass>(message: String) -> Self

Creates an instance of an exception from a PHP class type and a message.

Parameters

• message - Message to contain in the exception.

pub fn set_object(&mut self, object: Option<Zval>)

Set the Zval object for the exception.

Exceptions can be based of instantiated Zval objects when you are throwing a custom exception with stateful properties.

Parameters

• object - The Zval object.

pub fn throw(self) -> Result<()>

Throws the exception, returning nothing inside a result if successful and an error otherwise.

Trait Implementations

impl Debug for PhpException

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

Formats the value using the given formatter.

impl From<&str> for PhpException

fn from(str: &str) -> Self

Converts to this type from the input type.

impl From<Error> for PhpException

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<String> for PhpException

fn from(str: String) -> Self

Converts to this type from the input type.