| 1 | package SPVM::Sys::IO::DirStream; | ||
| 2 | |||
| 3 | 1; | ||
| 4 | |||
| 5 | =head1 Name | ||
| 6 | |||
| 7 | SPVM::Sys::IO::DirStream - C<DIR> structure in the C language. | ||
| 8 | |||
| 9 | =head1 Description | ||
| 10 | |||
| 11 | Sys::IO::DirStream class in L<SPVM> represents the L<DIR|https://linux.die.net/man/3/opendir> structure in the C language. | ||
| 12 | |||
| 13 | =head1 Usage | ||
| 14 | |||
| 15 | use Sys::IO::DirStream; | ||
| 16 | use Sys::IO; | ||
| 17 | |||
| 18 | my $dir = "foo"; | ||
| 19 | |||
| 20 | # Sys::IO::DirStream | ||
| 21 | my $dir_stream = Sys::IO->opendir($dir); | ||
| 22 | |||
| 23 | =head1 Details | ||
| 24 | |||
| 25 | This class is a pointer class. The pointer is set to an object of C<DIR> type in the C language. | ||
| 26 | |||
| 27 | =head1 Fields | ||
| 28 | |||
| 29 | =head2 closed | ||
| 30 | |||
| 31 | C<has closed : ro byte;> | ||
| 32 | |||
| 33 | The flag whether the directory stream is closed. | ||
| 34 | |||
| 35 | If this field is a true value, the directory stream is closed, otherwise opened. | ||
| 36 | |||
| 37 | =head1 Instance Methods | ||
| 38 | |||
| 39 | C<method DESTROY : void ();> | ||
| 40 | |||
| 41 | The destructor. | ||
| 42 | |||
| 43 | If L</"closed"> field is not a true value, closes the directory handle stored in the pointer. | ||
| 44 | |||
| 45 | =head1 See Also | ||
| 46 | |||
| 47 | =over 2 | ||
| 48 | |||
| 49 | =item * L<Sys|SPVM::Sys> | ||
| 50 | |||
| 51 | =back | ||
| 52 | |||
| 53 | =head1 Copyright & License | ||
| 54 | |||
| 55 | Copyright (c) 2023 Yuki Kimoto | ||
| 56 | |||
| 57 | MIT License | ||
| 58 |