The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KIMOTO / SPVM-IO-0.235 / lib / SPVM / IO / Dir.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

              
package SPVM::IO::Dir;
1;
=head1 Name
SPVM::IO::Dir - Directory Streams
=head1 Description
The IO::Dir class in L<SPVM> has methods for directory streams.
=head1 Usage
  use IO::Dir;
   
  my $dh = IO::Dir->new(".");
   
  while (my $dirent = $dh->read) {
    say $dirent->d_name;
  }
   
  my $offset = $dh->tell;
   
  $dh->seek($offset);
=head1 Details
=head2 Porting
This class is a Perl's L<IO::Dir> porting to L<SPVM>.
=head2 Implementation
An opened directory stream is automatically closed when the instance is destroyed.
=head1 Fields
=head2 dir_stream
C<has dir_stream : L<Sys::IO::DirStream|SPVM::Sys::IO::DirStream>;>
A directory stream.
=head1 Class Methods
C<static method new : L<IO::Dir|SPVM::IO::Dir> ($dir_path : string = undef);>
Creates a new L<IO::Dir|SPVM::IO::Dir> object, calls L</"open"> method with the directory path $dir_path, and returns the created object.
If $dir_path is not defined, L</"open"> method is not called.
Exceptions:
Exceptions thrown by L</"open"> method could be thrown.
See Also:
See L<IO#opendir|SPVM::IO/"opendir"> method if you find a method ported from Perl opendir function.
=head1 Instance Methods
=head2 open
C<method open : void ($dir_path : string);>
Opens a directory stream given the directory path $dir_path and sets L</"dir_stream"> field to it.
This method calls L<Sys#opendir|SPVM::Sys/"opendir"> method.
Exceptions:
Exceptions thrown by L<Sys#opendir|SPVM::Sys/"opendir"> method could be thrown.
=head2 read
C<method read : Sys::IO::Dirent ();>
Reads a directory entry from the directory stream stored in L</"dir_stream"> field and returns it.
This method calls L<Sys#readdir|SPVM::Sys/"readdir"> method.
Exceptions:
Exceptions thrown by L<Sys#readdir|SPVM::Sys/"readdir"> method could be thrown.
=head2 seek
C<method seek : void ($offset : long);>
Sets the location in the directory stream stored in L</"dir_stream"> field to the offset $offset.
$offset should be the return value of L</"tell"> method.
This method calls L<Sys#seekdir|SPVM::Sys/"seekdir"> method.
Exceptions:
Exceptions thrown by L<Sys#seekdir|SPVM::Sys/"seekdir"> method could be thrown.
=head2 tell
C<method tell : long ();>
Returns the location in the directory stream stored in L</"dir_stream"> field.
This method calls L<Sys#telldir|SPVM::Sys/"telldir"> method.
Exceptions:
Exceptions thrown by L<Sys#telldir|SPVM::Sys/"telldir"> method could be thrown.
=head2 rewind
C<method rewind : void ();>
Resets the position of the directory stream stored in L</"dir_stream"> field.
This method calls L<Sys#rewinddir|SPVM::Sys/"rewinddir"> method.
Exceptions:
Exceptions thrown by L<Sys#rewinddir|SPVM::Sys/"rewinddir"> method could be thrown.
=head2 close
C<method close : void ();>
Closes the directory stream stored in L</"dir_stream"> field.
This method calls L<Sys#closedir|SPVM::Sys/"closedir"> method.
Exceptions:
Exceptions thrown by L<Sys#closedir|SPVM::Sys/"closedir"> method could be thrown.
=head2 opened
C<method opened : int ();>
If the directory stream stored in L</"dir_stream"> is opened, returns 1, otherwise returns 0.
=head1 Copyright & License
Copyright (c) 2024 Yuki Kimoto
MIT License