From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

WRATH / Filesys-POSIX-0.9.2-2011071201 / lib / Filesys / POSIX / Directory.pm 

            

              
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
100
101
102
103
104
105
106
107
108
—
109
110
111
112
113
114
115
116
117
118
119
120
—
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
—
137
138
139
140
141
142
143
144
145
146
147
—
148
149
150
151
152
153
154
155
156
157
158
159
—
160
161
162
163
164
165
166
167
168
169
—
170
171
172
173
174
175

              
package Filesys::POSIX::Directory;
use strict;
use warnings;
use Carp qw/confess/;
=head1 NAME
Filesys::POSIX::Directory - Base class for implementing directory structures
=head1 DESCRIPTION
Filesys::POSIX::Directory is a common interface used to implement classes that
act like directories, and should be able to be accessed randomly or in an
iterative fashion.
Classes which wish to implement the interface documented herein should provide
implementations for ALL methods listed in this document, in the manner in which
they are described within this document.
=head1 RANDOM ACCESS
=over
=item C<$directory-E<gt>get($name)>
If the current directory contains an item named for C<$name>, return the
corresponding inode.  Otherwise, an C<undef> is returned.
=cut
sub get {
    confess('Not implemented');
}
=item C<$directory-E<gt>set($name, $inode)>
Store a reference to C<$inode> in the current directory, named after the member
label C<$name>.  If an item already exists for C<$name>, then it will be
replaced by C<$inode>.
=cut
sub set {
    confess('Not implemented');
}
=item C<$directory-E<gt>exists($name)>
Returns true if a member called C<$name> exists in the current directory.
Returns false if no such member inode is listed.
=cut
sub exists {
    confess('Not implemented');
}
=item C<$directory-E<gt>detach($name)>
Drop any references to a member called C<$name> in the current directory.  No
side effects outside of the directory object instance shall occur.
=cut
sub detach {
    confess('Not implemented');
}
=item C<$directory-E<gt>delete($name)>
Drop any references to a member called C<$name> in the current directory.  Side
effects to other system resources referenced by this directory member may
potentially occur, depending on the specific directory implementation.
=cut
sub delete {
    confess('Not implemented');
}
=back
=head1 LIST ACCESS
=over
=item C<$directory-E<gt>list()>
Return a list of all items in the current directory, including C<.> and C<..>.
=cut
sub list {
    confess('Not implemented');
}
=item C<$directory-E<gt>count()>
Return the number of all items in the current directory, including C<.> and
C<..>.
=cut
sub count {
    confess('Not implemented');
}
=item C<$directory-E<gt>empty()>
Returns true if the directory only contains the C<.> and C<..> entries.
=cut
sub empty {
    my ($self) = @_;
    return $self->count == 2;
}
=back
=head1 ITERATIVE ACCESS
=over
=item C<$directory-E<gt>open()>
Prepare the current directory object for iterative reading access.
=cut
sub open {
    confess('Not implemented');
}
=item C<$directory-E<gt>rewind()>
Rewind the current directory object to the beginning of the directory list when
being accessed iteratively.
=cut
sub rewind {
    confess('Not implemented');
}
=item C<$directory-E<gt>read()>
Read and return a single item from the directory, advancing the pointer to the
next item to be read, if any.  A list containing both the name of the object,
and the inode it references, are returned.
=cut
sub read {
    confess('Not implemented');
}
=item C<$directory-E<gt>close()>
Close the current directory for iterative access.
=cut
sub close {
    confess('Not implemented');
}
=back
=cut
1;