Struct Cop 

pub struct Cop(/* private fields */);

Non-null pointer to a Perl COP. Same ABI as *mut COP. Non-owning, like the other newtypes.

Implementations

impl Cop

pub unsafe fn from_raw_unchecked(p: *const COP) -> Self

Wrap a raw COP pointer without checking for null.

Safety

Caller must guarantee p is non-null and points to a valid COP for at least the lifetime of the resulting Cop. Prefer Op::as_cop, which class-checks first.

pub fn from_raw(p: *const COP) -> Option<Self>

Wrap a raw COP pointer, returning None on null input.

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

Raw pointer for FFI calls.

pub fn line(&self) -> u32

Source line of the statement this COP opens (CopLINE).

Examples found in repository

examples/walker_stash.rs (line 21)

fn print_tree(perl: &Perl, op: Op, level: usize) {
    let name = op.name().unwrap_or("<custom>");
    let loc = op
        .as_cop(perl)
        .map(|cop| format!(" (line {})", cop.line()))
        .unwrap_or_default();
    println!("{}{name}{loc}", "  ".repeat(level));
    for kid in op.kids() {
        print_tree(perl, kid, level + 1);
    }
}

examples/walker_subs.rs (line 37)

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

    let sv0 = perl.get_sv("0", 0).expect("$0 is always set");
    let main_file = String::from_utf8_lossy(sv0.pv(&perl)).into_owned();
    println!("$0 = {main_file:?}");

    let mut walker = StashWalker::new(&perl);
    walker.walk("main", &mut |e| {
        if e.cv.file().as_deref() != Some(main_file.as_str()) {
            return;
        }
        let qual = e
            .cv
            .names(&perl)
            .map(|(full, _)| full)
            .unwrap_or_else(|| format!("{}::{}", e.package, e.name));
        let line = e.cv.first_cop(&perl).map(|c| c.line());
        println!("sub {qual} (first statement at line {line:?})");

        let lexicals: Vec<String> = e
            .cv
            .pad_names()
            .flatten() // skip unnamed slots
            .filter_map(|pn| {
                // Target/temporary slots have a non-null but empty PV;
                // only real `my`/`our` names are interesting here.
                let pv = pn.pv().filter(|s| !s.is_empty())?;
                Some(match pn.type_stash_name() {
                    Some(t) => format!("{pv}: {t}"),
                    None => pv,
                })
            })
            .collect();
        println!("  lexicals: {lexicals:?}");

        let ops: Vec<&str> = e
            .cv
            .start_op()
            .into_iter()
            .flat_map(|s| s.next_iter())
            .take(20)
            .map(|o| o.name().unwrap_or("<custom>"))
            .collect();
        println!("  ops (execution order, first 20): {}", ops.join(" "));
    });
}

pub fn file(&self) -> Option<String>

Source file of the statement (CopFILE); "-e" for one-liner scripts, "(eval N)" inside string evals.

Trait Implementations

impl Clone for Cop

fn clone(&self) -> Cop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Cop