.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Devel::StackTrace::Frame 3pm"
.TH Devel::StackTrace::Frame 3pm 2024-01-20 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Devel::StackTrace::Frame \- A single frame in a stack trace
.SH VERSION
.IX Header "VERSION"
version 2.05
.SH DESCRIPTION
.IX Header "DESCRIPTION"
See Devel::StackTrace for details.
.SH METHODS
.IX Header "METHODS"
See Perl's \f(CW\*(C`caller\*(C'\fR documentation for more information on what these methods
return.
.ie n .SS $frame\->package
.el .SS \f(CW$frame\fP\->package
.IX Subsection "$frame->package"
The package which created this frame.
.ie n .SS $frame\->filename
.el .SS \f(CW$frame\fP\->filename
.IX Subsection "$frame->filename"
The filename which created this frame.
.ie n .SS $frame\->line
.el .SS \f(CW$frame\fP\->line
.IX Subsection "$frame->line"
The line where the frame was created.
.ie n .SS $frame\->subroutine
.el .SS \f(CW$frame\fP\->subroutine
.IX Subsection "$frame->subroutine"
The subroutine which created this frame.
.ie n .SS $frame\->hasargs
.el .SS \f(CW$frame\fP\->hasargs
.IX Subsection "$frame->hasargs"
This will be true if a new \f(CW@_\fR was created for this this frame.
.ie n .SS $frame\->wantarray
.el .SS \f(CW$frame\fP\->wantarray
.IX Subsection "$frame->wantarray"
This indicates the context for the call for this frame. This will be true if
called in array context, false in scalar context, and \f(CW\*(C`undef\*(C'\fR in void context.
.ie n .SS $frame\->evaltext
.el .SS \f(CW$frame\fP\->evaltext
.IX Subsection "$frame->evaltext"
Returns undef if the frame was not part of an eval.
.ie n .SS $frame\->is_require
.el .SS \f(CW$frame\fP\->is_require
.IX Subsection "$frame->is_require"
Returns undef if the frame was not part of a require.
.ie n .SS $frame\->args
.el .SS \f(CW$frame\fP\->args
.IX Subsection "$frame->args"
Returns the arguments passed to the frame. Note that any arguments that are
references are returned as references, not copies.
.ie n .SS $frame\->hints
.el .SS \f(CW$frame\fP\->hints
.IX Subsection "$frame->hints"
Returns the value of \f(CW$^H\fR for this frame.
.ie n .SS $frame\->bitmask
.el .SS \f(CW$frame\fP\->bitmask
.IX Subsection "$frame->bitmask"
Returns the value of \f(CW$bitmask\fR for this frame.
.ie n .SS $frame\->as_string
.el .SS \f(CW$frame\fP\->as_string
.IX Subsection "$frame->as_string"
Returns a string containing a description of the frame.
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted at <https://github.com/houseabsolute/Devel\-StackTrace/issues>.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Devel-StackTrace can be found at <https://github.com/houseabsolute/Devel\-StackTrace>.
.SH AUTHOR
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2000 \- 2024 by David Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve
.PP
The full text of the license can be found in the
\&\fILICENSE\fR file included with this distribution.