Debian Codegraph @

upstream/mageia-cauldron/man3pm/DirHandle.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 "DirHandle 3pm"
61 .TH DirHandle 3pm 2023-12-22 "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 DirHandle \- (obsolete) supply object methods for directory handles
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 6
71 \& # recommended approach since Perl 5.6: do not use DirHandle
72 \& if (opendir my $d, \*(Aq.\*(Aq) {
73 \& while (readdir $d) { something($_); }
74 \& rewind $d;
75 \& while (readdir $d) { something_else($_); }
76 \& }
77 \&
78 \& # how you would use this module if you were going to
79 \& use DirHandle;
80 \& if (my $d = DirHandle\->new(".")) {
81 \& while (defined($_ = $d\->read)) { something($_); }
82 \& $d\->rewind;
83 \& while (defined($_ = $d\->read)) { something_else($_); }
84 \& }
85 .Ve
86 .SH DESCRIPTION
87 .IX Header "DESCRIPTION"
88 \&\fBThere is no reason to use this module nowadays.\fR
89 .PP
90 The \f(CW\*(C`DirHandle\*(C'\fR method provide an alternative interface to the
91 \&\fBopendir()\fR, \fBclosedir()\fR, \fBreaddir()\fR, and \fBrewinddir()\fR functions.
92 .PP
93 Up to Perl 5.5, \fBopendir()\fR could not autovivify a directory handle from
94 \&\f(CW\*(C`undef\*(C'\fR, so using a lexical handle required using a function from Symbol
95 to create an anonymous glob, which took a separate step.
96 \&\f(CW\*(C`DirHandle\*(C'\fR encapsulates this, which allowed cleaner code than \fBopendir()\fR.
97 Since Perl 5.6, \fBopendir()\fR alone has been all you need for lexical handles.