Debian Codegraph @

upstream/mageia-cauldron/man3pm/autodie::Scope::Guard.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 "autodie::Scope::Guard 3pm"
61 .TH autodie::Scope::Guard 3pm 2023-12-30 "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 autodie::Scope::Guard \- Wrapper class for calling subs at end of scope
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 4
71 \& use autodie::Scope::Guard;
72 \& $^H{\*(Aqmy\-key\*(Aq} = autodie::Scope::Guard\->new(sub {
73 \& print "Hallo world\en";
74 \& });
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This class is used to bless perl subs so that they are invoked when
79 they are destroyed. This is mostly useful for ensuring the code is
80 invoked at end of scope. This module is not a part of autodie\*(Aqs
81 public API.
82 .PP
83 This module is directly inspired by chocolateboy\*(Aqs excellent
84 Scope::Guard module.
85 .SS Methods
86 .IX Subsection "Methods"
87 \fInew\fR
88 .IX Subsection "new"
89 .PP
90 .Vb 1
91 \& my $hook = autodie::Scope::Guard\->new(sub {});
92 .Ve
93 .PP
94 Creates a new \f(CW\*(C`autodie::Scope::Guard\*(C'\fR, which will invoke the given
95 sub once it goes out of scope (i.e. its DESTROY handler is called).
96 .SH AUTHOR
97 .IX Header "AUTHOR"
98 Copyright 2008\-2009, Paul Fenwick <[email protected]>
99 .SH LICENSE
100 .IX Header "LICENSE"
101 This module is free software. You may distribute it under the
102 same terms as Perl itself.