ext-php-rs 0.15.9

Bindings for the Zend API to build PHP extensions natively in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

#![doc = include_str!("../README.md")]
#![deny(clippy::unwrap_used)]
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(unsafe_attr_outside_unsafe)]
#![warn(clippy::pedantic)]
#![cfg_attr(docs, feature(doc_cfg))]
#![cfg_attr(windows, feature(abi_vectorcall))]

pub mod alloc;
pub mod args;
pub mod binary;
pub mod binary_slice;
pub mod builders;
pub mod convert;
pub mod error;
pub mod exception;
pub mod ffi;
pub mod flags;
#[macro_use]
pub mod macros;
pub mod boxed;
pub mod class;
#[cfg(any(docs, feature = "closure"))]
#[cfg_attr(docs, doc(cfg(feature = "closure")))]
pub mod closure;
pub mod constant;
pub mod describe;
#[cfg(feature = "embed")]
pub mod embed;
#[cfg(feature = "enum")]
pub mod enum_;
pub mod php_eval;
#[cfg(feature = "observer")]
#[cfg_attr(docs, doc(cfg(feature = "observer")))]
pub mod observer {
    //! Observer API for function call profiling, tracing, error and exception monitoring.
    pub use crate::zend::error_observer::{BacktraceFrame, ErrorInfo, ErrorObserver, ErrorType};
    pub use crate::zend::exception_observer::{ExceptionInfo, ExceptionObserver};
    pub use crate::zend::observer::{FcallInfo, FcallObserver};
}
#[doc(hidden)]
pub mod internal;

// Re-export inventory for use by macros
#[doc(hidden)]
pub use inventory;
pub mod props;
pub mod rc;
#[cfg(test)]
pub mod test;
pub mod types;
mod util;
pub mod zend;

/// A module typically glob-imported containing the typically required macros
/// and imports.
pub mod prelude {

    pub use crate::builders::ModuleBuilder;
    #[cfg(any(docs, feature = "closure"))]
    #[cfg_attr(docs, doc(cfg(feature = "closure")))]
    pub use crate::closure::Closure;
    pub use crate::exception::{PhpException, PhpResult};
    #[cfg(feature = "enum")]
    pub use crate::php_enum;
    pub use crate::php_print;
    pub use crate::php_println;
    pub use crate::php_write;
    pub use crate::types::ZendCallable;
    #[cfg(feature = "observer")]
    pub use crate::zend::{
        BacktraceFrame, ErrorInfo, ErrorObserver, ErrorType, ExceptionInfo, ExceptionObserver,
        FcallInfo, FcallObserver,
    };
    pub use crate::zend::{BailoutGuard, ModuleGlobal, ModuleGlobals};
    pub use crate::{
        ZvalConvert, php_class, php_const, php_extern, php_function, php_impl, php_impl_interface,
        php_interface, php_module, wrap_constant, wrap_function, zend_fastcall,
    };
}

/// `ext-php-rs` version.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Whether the extension is compiled for PHP debug mode.
pub const PHP_DEBUG: bool = cfg!(php_debug);

/// Whether the extension is compiled for PHP thread-safe mode.
pub const PHP_ZTS: bool = cfg!(php_zts);

/// Whether the extension is compiled for PHP 8.1 or later.
pub const PHP_81: bool = cfg!(php81);

/// Whether the extension is compiled for PHP 8.2 or later.
pub const PHP_82: bool = cfg!(php82);

/// Whether the extension is compiled for PHP 8.3 or later.
pub const PHP_83: bool = cfg!(php83);

/// Whether the extension is compiled for PHP 8.4 or later.
pub const PHP_84: bool = cfg!(php84);

/// Whether the extension is compiled for PHP 8.5 or later.
pub const PHP_85: bool = cfg!(php85);

#[cfg(feature = "enum")]
pub use ext_php_rs_derive::php_enum;
pub use ext_php_rs_derive::{
    ZvalConvert, php_class, php_const, php_extern, php_function, php_impl, php_impl_interface,
    php_interface, php_module, wrap_constant, wrap_function, zend_fastcall,
};