Struct ext_php_rs::builders::ModuleBuilder

pub struct ModuleBuilder { /* private fields */ }

Builds a Zend module extension to be registered with PHP. Must be called from within an external function called get_module, returning a mutable pointer to a ModuleEntry.

use ext_php_rs::{
    builders::ModuleBuilder,
    zend::ModuleEntry,
    info_table_start, info_table_end, info_table_row
};

#[no_mangle]
pub extern "C" fn php_module_info(_module: *mut ModuleEntry) {
    info_table_start!();
    info_table_row!("column 1", "column 2");
    info_table_end!();
}

#[no_mangle]
pub extern "C" fn get_module() -> *mut ModuleEntry {
    ModuleBuilder::new("ext-name", "ext-version")
        .info_function(php_module_info)
        .build()
        .unwrap()
        .into_raw()
}

Implementations

impl ModuleBuilder

pub fn new<T: Into<String>, U: Into<String>>(name: T, version: U) -> Self

Creates a new module builder with a given name and version.

Arguments

• name - The name of the extension.
• version - The current version of the extension.

pub fn startup_function( self, func: extern "C" fn(_type: i32, _module_number: i32) -> i32 ) -> Self

Sets the startup function for the extension.

Arguments

• func - The function to be called on startup.

pub fn shutdown_function( self, func: extern "C" fn(_type: i32, _module_number: i32) -> i32 ) -> Self

Sets the shutdown function for the extension.

Arguments

• func - The function to be called on shutdown.

pub fn request_startup_function( self, func: extern "C" fn(_type: i32, _module_number: i32) -> i32 ) -> Self

Sets the request startup function for the extension.

Arguments

• func - The function to be called when startup is requested.

pub fn request_shutdown_function( self, func: extern "C" fn(_type: i32, _module_number: i32) -> i32 ) -> Self

Sets the request shutdown function for the extension.

Arguments

• func - The function to be called when shutdown is requested.

pub fn post_deactivate_function(self, func: extern "C" fn() -> i32) -> Self

Sets the post request shutdown function for the extension.

This function can be useful if you need to do any final cleanup at the very end of a request, after all other resources have been released. For example, if your extension creates any persistent resources that last beyond a single request, you could use this function to clean those up.

Arguments

• func - The function to be called when shutdown is requested.

pub fn info_function( self, func: extern "C" fn(zend_module: *mut ModuleEntry) ) -> Self

Sets the extension information function for the extension.

Arguments

• func - The function to be called to retrieve the information about the extension.

pub fn function(self, func: FunctionEntry) -> Self

Adds a function to the extension.

Arguments

• func - The function to be added to the extension.

pub fn build(self) -> Result<ModuleEntry>

Builds the extension and returns a ModuleEntry.

Returns a result containing the module entry if successful.

Trait Implementations

impl Clone for ModuleBuilder

fn clone(&self) -> ModuleBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleBuilder

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

Formats the value using the given formatter.