summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3pm/DirHandle.3pm
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/DirHandle.3pm')
-rw-r--r--upstream/mageia-cauldron/man3pm/DirHandle.3pm94
1 files changed, 94 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/DirHandle.3pm b/upstream/mageia-cauldron/man3pm/DirHandle.3pm
new file mode 100644
index 00000000..5e7ec76c
--- /dev/null
+++ b/upstream/mageia-cauldron/man3pm/DirHandle.3pm
@@ -0,0 +1,94 @@
+.\" -*- 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 "DirHandle 3pm"
+.TH DirHandle 3pm 2023-11-28 "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
+DirHandle \- (obsolete) supply object methods for directory handles
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 6
+\& # recommended approach since Perl 5.6: do not use DirHandle
+\& if (opendir my $d, \*(Aq.\*(Aq) {
+\& while (readdir $d) { something($_); }
+\& rewind $d;
+\& while (readdir $d) { something_else($_); }
+\& }
+\&
+\& # how you would use this module if you were going to
+\& use DirHandle;
+\& if (my $d = DirHandle\->new(".")) {
+\& while (defined($_ = $d\->read)) { something($_); }
+\& $d\->rewind;
+\& while (defined($_ = $d\->read)) { something_else($_); }
+\& }
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBThere is no reason to use this module nowadays.\fR
+.PP
+The \f(CW\*(C`DirHandle\*(C'\fR method provide an alternative interface to the
+\&\fBopendir()\fR, \fBclosedir()\fR, \fBreaddir()\fR, and \fBrewinddir()\fR functions.
+.PP
+Up to Perl 5.5, \fBopendir()\fR could not autovivify a directory handle from
+\&\f(CW\*(C`undef\*(C'\fR, so using a lexical handle required using a function from Symbol
+to create an anonymous glob, which took a separate step.
+\&\f(CW\*(C`DirHandle\*(C'\fR encapsulates this, which allowed cleaner code than \fBopendir()\fR.
+Since Perl 5.6, \fBopendir()\fR alone has been all you need for lexical handles.