Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Util::ExternalMeta.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::ExternalMeta 3pm"
61 .TH Test2::Util::ExternalMeta 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::ExternalMeta \- Allow third party tools to safely attach meta\-data
68 to your instances.
69 .SH DESCRIPTION
70 .IX Header "DESCRIPTION"
71 This package lets you define a clear, and consistent way to allow third party
72 tools to attach meta\-data to your instances. If your object consumes this
73 package, and imports its methods, then third party meta\-data has a safe place
74 to live.
75 .SH SYNOPSIS
76 .IX Header "SYNOPSIS"
77 .Vb 3
78 \& package My::Object;
79 \& use strict;
80 \& use warnings;
81 \&
82 \& use Test2::Util::ExternalMeta qw/meta get_meta set_meta delete_meta/;
83 \&
84 \& ...
85 .Ve
86 .PP
87 Now to use it:
88 .PP
89 .Vb 1
90 \& my $inst = My::Object\->new;
91 \&
92 \& $inst\->set_meta(foo => \*(Aqbar\*(Aq);
93 \& my $val = $inst\->get_meta(\*(Aqfoo\*(Aq);
94 .Ve
95 .SH "WHERE IS THE DATA STORED?"
96 .IX Header "WHERE IS THE DATA STORED?"
97 This package assumes your instances are blessed hashrefs, it will not work if
98 that is not true. It will store all meta\-data in the \f(CW\*(C`_meta\*(C'\fR key on your
99 objects hash. If your object makes use of the \f(CW\*(C`_meta\*(C'\fR key in its underlying
100 hash, then there is a conflict and you cannot use this package.
101 .SH EXPORTS
102 .IX Header "EXPORTS"
103 .ie n .IP "$val = $obj\->meta($key)" 4
104 .el .IP "\f(CW$val\fR = \f(CW$obj\fR\->meta($key)" 4
105 .IX Item "$val = $obj->meta($key)"
106 .PD 0
107 .ie n .IP "$val = $obj\->meta($key, $default)" 4
108 .el .IP "\f(CW$val\fR = \f(CW$obj\fR\->meta($key, \f(CW$default\fR)" 4
109 .IX Item "$val = $obj->meta($key, $default)"
110 .PD
111 This will get the value for a specified meta \f(CW$key\fR. Normally this will return
112 \&\f(CW\*(C`undef\*(C'\fR when there is no value for the \f(CW$key\fR, however you can specify a
113 \&\f(CW$default\fR value to set when no value is already set.
114 .ie n .IP "$val = $obj\->get_meta($key)" 4
115 .el .IP "\f(CW$val\fR = \f(CW$obj\fR\->get_meta($key)" 4
116 .IX Item "$val = $obj->get_meta($key)"
117 This will get the value for a specified meta \f(CW$key\fR. This does not have the
118 \&\f(CW$default\fR overhead that \f(CWmeta()\fR does.
119 .ie n .IP "$val = $obj\->delete_meta($key)" 4
120 .el .IP "\f(CW$val\fR = \f(CW$obj\fR\->delete_meta($key)" 4
121 .IX Item "$val = $obj->delete_meta($key)"
122 This will remove the value of a specified meta \f(CW$key\fR. The old \f(CW$val\fR will be
123 returned.
124 .ie n .IP "$obj\->set_meta($key, $val)" 4
125 .el .IP "\f(CW$obj\fR\->set_meta($key, \f(CW$val\fR)" 4
126 .IX Item "$obj->set_meta($key, $val)"
127 Set the value of a specified meta \f(CW$key\fR.
128 .SH "META\-KEY RESTRICTIONS"
129 .IX Header "META-KEY RESTRICTIONS"
130 Meta keys must be defined, and must be true when used as a boolean. Keys may
131 not be references. You are free to stringify a reference \f(CW"$ref"\fR for use as a
132 key, but this package will not stringify it for you.
133 .SH SOURCE
134 .IX Header "SOURCE"
135 The source code repository for Test2 can be found at
136 <https://github.com/Test\-More/test\-more/>.
137 .SH MAINTAINERS
138 .IX Header "MAINTAINERS"
139 .IP "Chad Granum <[email protected]>" 4
140 .IX Item "Chad Granum <[email protected]>"
141 .SH AUTHORS
142 .IX Header "AUTHORS"
143 .IP "Chad Granum <[email protected]>" 4
144 .IX Item "Chad Granum <[email protected]>"
145 .SH COPYRIGHT
146 .IX Header "COPYRIGHT"
147 Copyright Chad Granum <[email protected]>.
148 .PP
149 This program is free software; you can redistribute it and/or
150 modify it under the same terms as Perl itself.
151 .PP
152 See <https://dev.perl.org/licenses/>