Struct PhpInstance 

pub struct PhpInstance { /* private fields */ }

A PHP interpreter instance. One per thread.

Safety

Must be created and used on a single OS thread. PHP globals are thread-local (with NTS builds) but NOT safe to share across threads. Each worker thread must own its own PhpInstance.

Implementations

impl PhpInstance

pub fn boot() -> Result<Self>

Boot the PHP interpreter using the default embed SAPI.

This is the original POC path — simple but no HTTP request support.

pub fn boot_custom_sapi() -> Result<Self>

Boot the PHP interpreter using the custom Folk SAPI.

The Folk SAPI provides proper HTTP request/response lifecycle: $_SERVER, $_GET, $_POST, $_COOKIE, header() capture, etc.

pub fn set_request_context(&self, ctx: &mut RequestContext)

Set the request context before calling request_startup.

The RequestContext must live until request_shutdown is called.

pub fn clear_request_context(&self)

Clear the request context (called after request_shutdown).

pub fn request_startup(&mut self) -> Result<()>

Start a new request cycle.

pub fn request_shutdown(&mut self)

End the current request cycle.

pub fn eval(&mut self, code: &str) -> Result<EvalResult>

Evaluate a PHP code string and return the output.

pub fn call(&mut self, func_name: &str, args: &[&str]) -> Result<ZvalValue>

Call a PHP function by name with the given string arguments.

pub fn eval_protected(&mut self, code: &str) -> Result<EvalResult>

Evaluate PHP code with SIGSEGV protection.

Like eval() but also catches segfaults in C extensions. Returns error on SIGSEGV instead of crashing the process.

pub fn call_protected( &mut self, func_name: &str, args: &[&str], ) -> Result<ZvalValue>

Call a PHP function with SIGSEGV protection.

Like call() but also catches segfaults in C extensions.

pub fn call_binary( &mut self, func_name: &str, method: &str, params: &[u8], ) -> Result<Vec<u8>>

Call a PHP function with raw binary data (Phase A — no base64).

Passes method name and binary params directly via FFI pointers. PHP function signature: function($method, $params): string where $params is raw binary (e.g. msgpack).

pub fn take_output(&self) -> String

Take captured output, returning it as a string and clearing the buffer.

pub fn take_response(&self) -> ResponseData

Get the captured response data (custom SAPI only).

Trait Implementations

impl Drop for PhpInstance

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.