Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Util::Ref.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Util::Ref 3pm"
61 .TH Test2::Util::Ref 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Util::Ref \- Tools for inspecting or manipulating references.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 These are used by Test2::Tools to inspect, render, or manipulate references.
71 .SH EXPORTS
72 .IX Header "EXPORTS"
73 All exports are optional. You must specify subs to import.
74 .ie n .IP "$type = rtype($ref)" 4
75 .el .IP "\f(CW$type\fR = rtype($ref)" 4
76 .IX Item "$type = rtype($ref)"
77 A normalization between \f(CWScalar::Util::reftype()\fR and \f(CWref()\fR.
78 .Sp
79 Always returns a string.
80 .Sp
81 Returns \f(CW\*(AqREGEXP\*(Aq\fR for regex types
82 .Sp
83 Returns \f(CW\*(Aq\*(Aq\fR for non\-refs
84 .Sp
85 Otherwise returns what \f(CWScalar::Util::reftype()\fR returns.
86 .ie n .IP "$addr_str = render_ref($ref)" 4
87 .el .IP "\f(CW$addr_str\fR = render_ref($ref)" 4
88 .IX Item "$addr_str = render_ref($ref)"
89 Always returns a string. For unblessed references this returns something like
90 \&\f(CW"SCALAR(0x...)"\fR. For blessed references it returns
91 \&\f(CW"My::Thing=SCALAR(0x...)"\fR. The only difference between this and \f(CW$add_str =
92 "$thing"\fR is that it ignores any overloading to ensure it is always the ref
93 address.
94 .SH SOURCE
95 .IX Header "SOURCE"
96 The source code repository for Test2\-Suite can be found at
97 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
98 .SH MAINTAINERS
99 .IX Header "MAINTAINERS"
100 .IP "Chad Granum <[email protected]>" 4
101 .IX Item "Chad Granum <[email protected]>"
102 .SH AUTHORS
103 .IX Header "AUTHORS"
104 .IP "Chad Granum <[email protected]>" 4
105 .IX Item "Chad Granum <[email protected]>"
106 .PD 0
107 .IP "Kent Fredric <[email protected]>" 4
108 .IX Item "Kent Fredric <[email protected]>"
109 .PD
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright Chad Granum <[email protected]>.
113 .PP
114 This program is free software; you can redistribute it and/or
115 modify it under the same terms as Perl itself.
116 .PP
117 See \fIhttp://dev.perl.org/licenses/\fR