Debian Codegraph @

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