Debian Codegraph @

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