.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Test2::API::Stack 3"
.TH Test2::API::Stack 3 2025-07-25 "perl v5.42.0" "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
Test2::API::Stack \- Object to manage a stack of Test2::Hub
instances.
.SH "***INTERNALS NOTE***"
.IX Header "***INTERNALS NOTE***"
\&\fBThe internals of this package are subject to change at any time!\fR The public
methods provided will not change in backwards incompatible ways, but the
underlying implementation details might. \fBDo not break encapsulation here!\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is used to represent and manage a stack of Test2::Hub
objects. Hubs are usually in a stack so that you can push a new hub into place
that can intercept and handle events differently than the primary hub.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    my $stack = Test2::API::Stack\->new;
\&    my $hub = $stack\->top;
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$stack = Test2::API::Stack\->\fBnew()\fR" 4
.el .IP "\f(CW$stack\fR = Test2::API::Stack\->\fBnew()\fR" 4
.IX Item "$stack = Test2::API::Stack->new()"
This will create a new empty stack instance. All arguments are ignored.
.ie n .IP "$hub = $stack\->\fBnew_hub()\fR" 4
.el .IP "\f(CW$hub\fR = \f(CW$stack\fR\->\fBnew_hub()\fR" 4
.IX Item "$hub = $stack->new_hub()"
.PD 0
.ie n .IP "$hub = $stack\->new_hub(%params)" 4
.el .IP "\f(CW$hub\fR = \f(CW$stack\fR\->new_hub(%params)" 4
.IX Item "$hub = $stack->new_hub(%params)"
.ie n .IP "$hub = $stack\->new_hub(%params, class => $class)" 4
.el .IP "\f(CW$hub\fR = \f(CW$stack\fR\->new_hub(%params, class => \f(CW$class\fR)" 4
.IX Item "$hub = $stack->new_hub(%params, class => $class)"
.PD
This will generate a new hub and push it to the top of the stack. Optionally
you can provide arguments that will be passed into the constructor for the
Test2::Hub object.
.Sp
If you specify the \f(CW\*(C`\*(Aqclass\*(Aq => $class\*(C'\fR argument, the new hub will be an
instance of the specified class.
.Sp
Unless your parameters specify \f(CW\*(Aqformatter\*(Aq\fR or \f(CW\*(Aqipc\*(Aq\fR arguments, the
formatter and IPC instance will be inherited from the current top hub. You can
set the parameters to \f(CW\*(C`undef\*(C'\fR to avoid having a formatter or IPC instance.
.Sp
If there is no top hub, and you do not ask to leave IPC and formatter undef,
then a new formatter will be created, and the IPC instance from
Test2::API will be used.
.ie n .IP "$hub = $stack\->\fBtop()\fR" 4
.el .IP "\f(CW$hub\fR = \f(CW$stack\fR\->\fBtop()\fR" 4
.IX Item "$hub = $stack->top()"
This will return the top hub from the stack. If there is no top hub yet this
will create it.
.ie n .IP "$hub = $stack\->\fBpeek()\fR" 4
.el .IP "\f(CW$hub\fR = \f(CW$stack\fR\->\fBpeek()\fR" 4
.IX Item "$hub = $stack->peek()"
This will return the top hub from the stack. If there is no top hub yet this
will return undef.
.ie n .IP $stack\->cull 4
.el .IP \f(CW$stack\fR\->cull 4
.IX Item "$stack->cull"
This will call \f(CW\*(C`$hub\->cull\*(C'\fR on all hubs in the stack.
.ie n .IP "@hubs = $stack\->all" 4
.el .IP "\f(CW@hubs\fR = \f(CW$stack\fR\->all" 4
.IX Item "@hubs = $stack->all"
This will return all the hubs in the stack as a list.
.ie n .IP $stack\->clear 4
.el .IP \f(CW$stack\fR\->clear 4
.IX Item "$stack->clear"
This will completely remove all hubs from the stack. Normally you do not want
to do this, but there are a few valid reasons for it.
.ie n .IP $stack\->push($hub) 4
.el .IP \f(CW$stack\fR\->push($hub) 4
.IX Item "$stack->push($hub)"
This will push the new hub onto the stack.
.ie n .IP $stack\->pop($hub) 4
.el .IP \f(CW$stack\fR\->pop($hub) 4
.IX Item "$stack->pop($hub)"
This will pop a hub from the stack, if the hub at the top of the stack does not
match the hub you expect (passed in as an argument) it will throw an exception.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2 can be found at
<https://github.com/Test\-More/test\-more/>.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See <https://dev.perl.org/licenses/>
