Debian Codegraph @

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