.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "TAP::Parser::Result::Bailout 3perl" .TH TAP::Parser::Result::Bailout 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide" .\" 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" TAP::Parser::Result::Bailout \- Bailout result token. .SH "VERSION" .IX Header "VERSION" Version 3.42 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a subclass of TAP::Parser::Result. A token of this class will be returned if a bail out line is encountered. .PP .Vb 3 \& 1..5 \& ok 1 \- woo hooo! \& Bail out! Well, so much for "woo hooo!" .Ve .SH "OVERRIDDEN METHODS" .IX Header "OVERRIDDEN METHODS" Mainly listed here to shut up the pitiful screams of the pod coverage tests. They keep me awake at night. .IP "\(bu" 4 \&\f(CW\*(C`as_string\*(C'\fR .SS "Instance Methods" .IX Subsection "Instance Methods" \fI\f(CI\*(C`explanation\*(C'\fI\fR .IX Subsection "explanation" .PP .Vb 4 \& if ( $result\->is_bailout ) { \& my $explanation = $result\->explanation; \& print "We bailed out because ($explanation)"; \& } .Ve .PP If, and only if, a token is a bailout token, you can get an \*(L"explanation\*(R" via this method. The explanation is the text after the mystical \*(L"Bail out!\*(R" words which appear in the tap output.