Debian Codegraph @

upstream/debian-unstable/man3/Test2::Util::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::Util::Ref 3perl"
58 .TH Test2::Util::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::Util::Ref \- Tools for inspecting or manipulating references.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 These are used by Test2::Tools to inspect, render, or manipulate references.
68 .SH EXPORTS
69 .IX Header "EXPORTS"
70 All exports are optional. You must specify subs to import.
71 .ie n .IP "$type = rtype($ref)" 4
72 .el .IP "\f(CW$type\fR = rtype($ref)" 4
73 .IX Item "$type = rtype($ref)"
74 A normalization between \f(CWScalar::Util::reftype()\fR and \f(CWref()\fR.
75 .Sp
76 Always returns a string.
77 .Sp
78 Returns \f(CW\*(AqREGEXP\*(Aq\fR for regex types
79 .Sp
80 Returns \f(CW\*(Aq\*(Aq\fR for non-refs
81 .Sp
82 Otherwise returns what \f(CWScalar::Util::reftype()\fR returns.
83 .ie n .IP "$addr_str = render_ref($ref)" 4
84 .el .IP "\f(CW$addr_str\fR = render_ref($ref)" 4
85 .IX Item "$addr_str = render_ref($ref)"
86 Always returns a string. For unblessed references this returns something like
87 \&\f(CW"SCALAR(0x...)"\fR. For blessed references it returns
88 \&\f(CW"My::Thing=SCALAR(0x...)"\fR. The only difference between this and \f(CW$add_str =
89 "$thing"\fR is that it ignores any overloading to ensure it is always the ref
90 address.
91 .SH SOURCE
92 .IX Header "SOURCE"
93 The source code repository for Test2\-Suite can be found at
94 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
95 .SH MAINTAINERS
96 .IX Header "MAINTAINERS"
97 .IP "Chad Granum <[email protected]>" 4
98 .IX Item "Chad Granum <[email protected]>"
99 .SH AUTHORS
100 .IX Header "AUTHORS"
101 .PD 0
102 .IP "Chad Granum <[email protected]>" 4
103 .IX Item "Chad Granum <[email protected]>"
104 .IP "Kent Fredric <[email protected]>" 4
105 .IX Item "Kent Fredric <[email protected]>"
106 .PD
107 .SH COPYRIGHT
108 .IX Header "COPYRIGHT"
109 Copyright 2018 Chad Granum <[email protected]>.
110 .PP
111 This program is free software; you can redistribute it and/or
112 modify it under the same terms as Perl itself.
113 .PP
114 See \fIhttp://dev.perl.org/licenses/\fR