.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Compare::Bag 3"
.TH Test2::Compare::Bag 3 "2019-05-18" "perl v5.10.1" "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::Compare::Bag \- Internal representation of a bag comparison.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is an internal representation of a bag for comparison purposes.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$bool = $arr\->ending" 4
.el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->ending" 4
.IX Item "$bool = $arr->ending"
.PD 0
.ie n .IP "$arr\->set_ending($bool)" 4
.el .IP "\f(CW$arr\fR\->set_ending($bool)" 4
.IX Item "$arr->set_ending($bool)"
.PD
Set this to true if you would like to fail when the array being validated has
more items than the check. That is, if you check for 4 items but the array has
5 values, it will fail and list that unmatched item in the array as
unexpected. If set to false then it is assumed you do not care about extra
items.
.ie n .IP "$arrayref = $arr\->\fIitems()\fR" 4
.el .IP "\f(CW$arrayref\fR = \f(CW$arr\fR\->\fIitems()\fR" 4
.IX Item "$arrayref = $arr->items()"
Returns the arrayref of values to be checked in the array.
.ie n .IP "$arr\->set_items($arrayref)" 4
.el .IP "\f(CW$arr\fR\->set_items($arrayref)" 4
.IX Item "$arr->set_items($arrayref)"
Accepts an arrayref.
.Sp
\&\fBNote:\fR that there is no validation when using \f(CW\*(C`set_items\*(C'\fR, it is better to
use the \f(CW\*(C`add_item\*(C'\fR interface.
.ie n .IP "$name = $arr\->\fIname()\fR" 4
.el .IP "\f(CW$name\fR = \f(CW$arr\fR\->\fIname()\fR" 4
.IX Item "$name = $arr->name()"
Always returns the string \f(CW"<BAG>"\fR.
.ie n .IP "$bool = $arr\->verify(got => $got, exists => $bool)" 4
.el .IP "\f(CW$bool\fR = \f(CW$arr\fR\->verify(got => \f(CW$got\fR, exists => \f(CW$bool\fR)" 4
.IX Item "$bool = $arr->verify(got => $got, exists => $bool)"
Check if \f(CW$got\fR is an array reference or not.
.ie n .IP "$arr\->add_item($item)" 4
.el .IP "\f(CW$arr\fR\->add_item($item)" 4
.IX Item "$arr->add_item($item)"
Push an item onto the list of values to be checked.
.ie n .IP "@deltas = $arr\->deltas(got => $got, convert => \e&convert, seen => \e%seen)" 4
.el .IP "\f(CW@deltas\fR = \f(CW$arr\fR\->deltas(got => \f(CW$got\fR, convert => \e&convert, seen => \e%seen)" 4
.IX Item "@deltas = $arr->deltas(got => $got, convert => &convert, seen => %seen)"
Find the differences between the expected bag values and those in the \f(CW$got\fR
arrayref.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD 0
.IP "Gianni Ceccarelli <dakkar@thenautilus.net>" 4
.IX Item "Gianni Ceccarelli <dakkar@thenautilus.net>"
.PD
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD 0
.IP "Gianni Ceccarelli <dakkar@thenautilus.net>" 4
.IX Item "Gianni Ceccarelli <dakkar@thenautilus.net>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
Copyright 2018 Gianni Ceccarelli <dakkar@thenautilus.net>
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR
Copyright 2K16 - 2K18 Indonesian Hacker Rulez