Debian Codegraph @

upstream/debian-unstable/man3/Test2::Tools::Ref.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Test2::Tools::Ref 3perl"
58 .TH Test2::Tools::Ref 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Tools::Ref \- Tools for validating references.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This module contains tools that allow you to verify that something is a ref. It
68 also has tools to check if two refs are the same exact ref, or different. None of
69 the functions in this module do deep comparisons.
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& use Test2::Tools::Ref;
74 \&
75 \& # Ensure something is a ref.
76 \& ref_ok($ref);
77 \&
78 \& # Check that $ref is a HASH reference
79 \& ref_ok($ref, \*(AqHASH\*(Aq, \*(AqMust be a hash\*(Aq)
80 \&
81 \& ref_is($refa, $refb, "Same exact reference");
82 \&
83 \& ref_is_not($refa, $refb, "Not the same exact reference");
84 .Ve
85 .SH EXPORTS
86 .IX Header "EXPORTS"
87 All subs are exported by default.
88 .IP ref_ok($thing) 4
89 .IX Item "ref_ok($thing)"
90 .PD 0
91 .ie n .IP "ref_ok($thing, $type)" 4
92 .el .IP "ref_ok($thing, \f(CW$type\fR)" 4
93 .IX Item "ref_ok($thing, $type)"
94 .ie n .IP "ref_ok($thing, $type, $name)" 4
95 .el .IP "ref_ok($thing, \f(CW$type\fR, \f(CW$name\fR)" 4
96 .IX Item "ref_ok($thing, $type, $name)"
97 .PD
98 This checks that \f(CW$thing\fR is a reference. If \f(CW$type\fR is specified then it
99 will check that \f(CW$thing\fR is that type of reference.
100 .ie n .IP "ref_is($ref1, $ref2, $name)" 4
101 .el .IP "ref_is($ref1, \f(CW$ref2\fR, \f(CW$name\fR)" 4
102 .IX Item "ref_is($ref1, $ref2, $name)"
103 Verify that two references are the exact same reference.
104 .ie n .IP "ref_is_not($ref1, $ref2, $name)" 4
105 .el .IP "ref_is_not($ref1, \f(CW$ref2\fR, \f(CW$name\fR)" 4
106 .IX Item "ref_is_not($ref1, $ref2, $name)"
107 Verify that two references are not the exact same reference.
108 .SH SOURCE
109 .IX Header "SOURCE"
110 The source code repository for Test2\-Suite can be found at
111 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
112 .SH MAINTAINERS
113 .IX Header "MAINTAINERS"
114 .IP "Chad Granum <[email protected]>" 4
115 .IX Item "Chad Granum <[email protected]>"
116 .SH AUTHORS
117 .IX Header "AUTHORS"
118 .PD 0
119 .IP "Chad Granum <[email protected]>" 4
120 .IX Item "Chad Granum <[email protected]>"
121 .PD
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2018 Chad Granum <[email protected]>.
125 .PP
126 This program is free software; you can redistribute it and/or
127 modify it under the same terms as Perl itself.
128 .PP
129 See \fIhttp://dev.perl.org/licenses/\fR