Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

DirHandle (3)

Name

DirHandle - (obsolete) supply object methods for directory handles

Synopsis

# recommended approach since Perl 5.6: do not use DirHandle
if (opendir my $d, '.') {
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($_); }
}

Description

Perl Programmers Reference Guide                                  DirHandle(3)



NAME
       DirHandle - (obsolete) supply object methods for directory handles

SYNOPSIS
           # recommended approach since Perl 5.6: do not use DirHandle
           if (opendir my $d, '.') {
               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($_); }
           }

DESCRIPTION
       There is no reason to use this module nowadays.

       The "DirHandle" method provide an alternative interface to the
       opendir(), closedir(), readdir(), and rewinddir() functions.

       Up to Perl 5.5, opendir() could not autovivify a directory handle from
       "undef", so using a lexical handle required using a function from
       Symbol to create an anonymous glob, which took a separate step.
       "DirHandle" encapsulates this, which allowed cleaner code than
       opendir().  Since Perl 5.6, opendir() alone has been all you need for
       lexical handles.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                      DirHandle(3)