1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Util::ExternalMeta 3pm"
.TH Test2::Util::ExternalMeta 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test2::Util::ExternalMeta \- Allow third party tools to safely attach meta\-data
to your instances.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package lets you define a clear, and consistent way to allow third party
tools to attach meta-data to your instances. If your object consumes this
package, and imports its methods, then third party meta-data has a safe place
to live.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& package My::Object;
\& use strict;
\& use warnings;
\&
\& use Test2::Util::ExternalMeta qw/meta get_meta set_meta delete_meta/;
\&
\& ...
.Ve
.PP
Now to use it:
.PP
.Vb 1
\& my $inst = My::Object\->new;
\&
\& $inst\->set_meta(foo => \*(Aqbar\*(Aq);
\& my $val = $inst\->get_meta(\*(Aqfoo\*(Aq);
.Ve
.SH "WHERE IS THE DATA STORED?"
.IX Header "WHERE IS THE DATA STORED?"
This package assumes your instances are blessed hashrefs, it will not work if
that is not true. It will store all meta-data in the \f(CW\*(C`_meta\*(C'\fR key on your
objects hash. If your object makes use of the \f(CW\*(C`_meta\*(C'\fR key in its underlying
hash, then there is a conflict and you cannot use this package.
.SH EXPORTS
.IX Header "EXPORTS"
.ie n .IP "$val = $obj\->meta($key)" 4
.el .IP "\f(CW$val\fR = \f(CW$obj\fR\->meta($key)" 4
.IX Item "$val = $obj->meta($key)"
.PD 0
.ie n .IP "$val = $obj\->meta($key, $default)" 4
.el .IP "\f(CW$val\fR = \f(CW$obj\fR\->meta($key, \f(CW$default\fR)" 4
.IX Item "$val = $obj->meta($key, $default)"
.PD
This will get the value for a specified meta \f(CW$key\fR. Normally this will return
\&\f(CW\*(C`undef\*(C'\fR when there is no value for the \f(CW$key\fR, however you can specify a
\&\f(CW$default\fR value to set when no value is already set.
.ie n .IP "$val = $obj\->get_meta($key)" 4
.el .IP "\f(CW$val\fR = \f(CW$obj\fR\->get_meta($key)" 4
.IX Item "$val = $obj->get_meta($key)"
This will get the value for a specified meta \f(CW$key\fR. This does not have the
\&\f(CW$default\fR overhead that \f(CWmeta()\fR does.
.ie n .IP "$val = $obj\->delete_meta($key)" 4
.el .IP "\f(CW$val\fR = \f(CW$obj\fR\->delete_meta($key)" 4
.IX Item "$val = $obj->delete_meta($key)"
This will remove the value of a specified meta \f(CW$key\fR. The old \f(CW$val\fR will be
returned.
.ie n .IP "$obj\->set_meta($key, $val)" 4
.el .IP "\f(CW$obj\fR\->set_meta($key, \f(CW$val\fR)" 4
.IX Item "$obj->set_meta($key, $val)"
Set the value of a specified meta \f(CW$key\fR.
.SH "META-KEY RESTRICTIONS"
.IX Header "META-KEY RESTRICTIONS"
Meta keys must be defined, and must be true when used as a boolean. Keys may
not be references. You are free to stringify a reference \f(CW"$ref"\fR for use as a
key, but this package will not stringify it for you.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR
|
