summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/autodie::Scope::Guard.3perl
blob: be1f4ee84626636cfa2312cd23d760d935ea2aa2 (plain)
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
.\" -*- 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 "autodie::Scope::Guard 3perl"
.TH autodie::Scope::Guard 3perl 2024-05-30 "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
autodie::Scope::Guard \- Wrapper class for calling subs at end of scope
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    use autodie::Scope::Guard;
\&    $^H{\*(Aqmy\-key\*(Aq} = autodie::Scope::Guard\->new(sub {
\&        print "Hallo world\en";
\&    });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class is used to bless perl subs so that they are invoked when
they are destroyed.  This is mostly useful for ensuring the code is
invoked at end of scope.  This module is not a part of autodie's
public API.
.PP
This module is directly inspired by chocolateboy's excellent
Scope::Guard module.
.SS Methods
.IX Subsection "Methods"
\fInew\fR
.IX Subsection "new"
.PP
.Vb 1
\&  my $hook = autodie::Scope::Guard\->new(sub {});
.Ve
.PP
Creates a new \f(CW\*(C`autodie::Scope::Guard\*(C'\fR, which will invoke the given
sub once it goes out of scope (i.e. its DESTROY handler is called).
.SH AUTHOR
.IX Header "AUTHOR"
Copyright 2008\-2009, Paul Fenwick <pjf@perltraining.com.au>
.SH LICENSE
.IX Header "LICENSE"
This module is free software.  You may distribute it under the
same terms as Perl itself.