Struct Perl 

pub struct Perl { /* private fields */ }

A live Perl interpreter. Allocated by perl_alloc and torn down by perl_destruct on drop.

The my_perl field is NonNull<PerlInterpreter> so that the “interpreter is never null” invariant is encoded in the type. FFI calls extract a raw pointer via Perl::as_ptr — that’s the boundary where Rust’s safe-typed world meets the C ABI.

Implementations

impl Perl

pub fn new() -> Self

Allocate and construct a fresh interpreter. Panics on allocation failure (typically OOM, very rare).

Examples found in repository

examples/scan_ops.rs (line 30)

fn main() {
    let mut perl = Perl::new();
    perl.parse_env_args(env::args(), env::vars());

    // Standard C-style THX setup at the top of the function:
    let my_perl = perl.as_ptr();
    scan_ops(PL_main_start!(my_perl));
}

pub fn as_ptr(&self) -> *mut PerlInterpreter

Raw pointer for FFI. The conventional name is my_perl at the call site — see docs/plan/README.md §3.8 for naming rules.

Examples found in repository

examples/scan_ops.rs (line 34)

fn main() {
    let mut perl = Perl::new();
    perl.parse_env_args(env::args(), env::vars());

    // Standard C-style THX setup at the top of the function:
    let my_perl = perl.as_ptr();
    scan_ops(PL_main_start!(my_perl));
}

pub unsafe fn from_raw_unchecked(p: *mut PerlInterpreter) -> Self

Wrap a raw *mut PerlInterpreter as a borrowed Perl.

Safety

• p must point to a live, valid interpreter.
• The returned Perl MUST NOT be dropped: its Drop runs perl_destruct, tearing down an interpreter this constructor does not own. The intended usage is to wrap in core::mem::ManuallyDrop immediately. The #[xs_sub] proc-macro does this when a body declares a my_perl: &Perl first parameter.

pub fn parse<S: AsRef<str>>(&mut self, args: &[S], envp: &[S]) -> i32

perl_parse with an explicit args / envp slice.

pub fn parse_env_args(&mut self, args: Args, envp: Vars) -> i32

perl_parse driven from std::env::args() / vars().

Examples found in repository

examples/scan_ops.rs (line 31)

fn main() {
    let mut perl = Perl::new();
    perl.parse_env_args(env::args(), env::vars());

    // Standard C-style THX setup at the top of the function:
    let my_perl = perl.as_ptr();
    scan_ops(PL_main_start!(my_perl));
}

Trait Implementations

impl Default for Perl

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Perl

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.