Filename | /home/hejohns/perl5/lib/perl5/x86_64-linux-gnu-thread-multi/IO/Seekable.pm |
Statements | Executed 15 statements in 305µs |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
1 | 1 | 1 | 1.34ms | 2.62ms | BEGIN@100 | IO::Seekable::
1 | 1 | 1 | 9µs | 9µs | BEGIN@97 | IO::Seekable::
1 | 1 | 1 | 5µs | 141µs | BEGIN@103 | IO::Seekable::
1 | 1 | 1 | 4µs | 21µs | BEGIN@98 | IO::Seekable::
1 | 1 | 1 | 3µs | 5µs | BEGIN@99 | IO::Seekable::
0 | 0 | 0 | 0s | 0s | seek | IO::Seekable::
0 | 0 | 0 | 0s | 0s | sysseek | IO::Seekable::
0 | 0 | 0 | 0s | 0s | tell | IO::Seekable::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | # | ||||
2 | |||||
3 | package IO::Seekable; | ||||
4 | |||||
5 | =head1 NAME | ||||
6 | |||||
7 | IO::Seekable - supply seek based methods for I/O objects | ||||
8 | |||||
9 | =head1 SYNOPSIS | ||||
10 | |||||
11 | use IO::Seekable; | ||||
12 | package IO::Something; | ||||
13 | @ISA = qw(IO::Seekable); | ||||
14 | |||||
15 | =head1 DESCRIPTION | ||||
16 | |||||
17 | C<IO::Seekable> does not have a constructor of its own as it is intended to | ||||
18 | be inherited by other C<IO::Handle> based objects. It provides methods | ||||
19 | which allow seeking of the file descriptors. | ||||
20 | |||||
21 | =over 4 | ||||
22 | |||||
23 | =item $io->getpos | ||||
24 | |||||
25 | Returns an opaque value that represents the current position of the | ||||
26 | IO::File, or C<undef> if this is not possible (eg an unseekable stream such | ||||
27 | as a terminal, pipe or socket). If the fgetpos() function is available in | ||||
28 | your C library it is used to implements getpos, else perl emulates getpos | ||||
29 | using C's ftell() function. | ||||
30 | |||||
31 | =item $io->setpos | ||||
32 | |||||
33 | Uses the value of a previous getpos call to return to a previously visited | ||||
34 | position. Returns "0 but true" on success, C<undef> on failure. | ||||
35 | |||||
36 | =back | ||||
37 | |||||
38 | See L<perlfunc> for complete descriptions of each of the following | ||||
39 | supported C<IO::Seekable> methods, which are just front ends for the | ||||
40 | corresponding built-in functions: | ||||
41 | |||||
42 | =over 4 | ||||
43 | |||||
44 | =item $io->seek ( POS, WHENCE ) | ||||
45 | |||||
46 | Seek the IO::File to position POS, relative to WHENCE: | ||||
47 | |||||
48 | =over 8 | ||||
49 | |||||
50 | =item WHENCE=0 (SEEK_SET) | ||||
51 | |||||
52 | POS is absolute position. (Seek relative to the start of the file) | ||||
53 | |||||
54 | =item WHENCE=1 (SEEK_CUR) | ||||
55 | |||||
56 | POS is an offset from the current position. (Seek relative to current) | ||||
57 | |||||
58 | =item WHENCE=2 (SEEK_END) | ||||
59 | |||||
60 | POS is an offset from the end of the file. (Seek relative to end) | ||||
61 | |||||
62 | =back | ||||
63 | |||||
64 | The SEEK_* constants can be imported from the C<Fcntl> module if you | ||||
65 | don't wish to use the numbers C<0> C<1> or C<2> in your code. | ||||
66 | |||||
67 | Returns C<1> upon success, C<0> otherwise. | ||||
68 | |||||
69 | =item $io->sysseek( POS, WHENCE ) | ||||
70 | |||||
71 | Similar to $io->seek, but sets the IO::File's position using the system | ||||
72 | call lseek(2) directly, so will confuse most perl IO operators except | ||||
73 | sysread and syswrite (see L<perlfunc> for full details) | ||||
74 | |||||
75 | Returns the new position, or C<undef> on failure. A position | ||||
76 | of zero is returned as the string C<"0 but true"> | ||||
77 | |||||
78 | =item $io->tell | ||||
79 | |||||
80 | Returns the IO::File's current position, or -1 on error. | ||||
81 | |||||
82 | =back | ||||
83 | |||||
84 | =head1 SEE ALSO | ||||
85 | |||||
86 | L<perlfunc>, | ||||
87 | L<perlop/"I/O Operators">, | ||||
88 | L<IO::Handle> | ||||
89 | L<IO::File> | ||||
90 | |||||
91 | =head1 HISTORY | ||||
92 | |||||
93 | Derived from FileHandle.pm by Graham Barr E<lt>gbarr@pobox.comE<gt> | ||||
94 | |||||
95 | =cut | ||||
96 | |||||
97 | 2 | 26µs | 1 | 9µs | # spent 9µs within IO::Seekable::BEGIN@97 which was called:
# once (9µs+0s) by File::Temp::BEGIN@151 at line 97 # spent 9µs making 1 call to IO::Seekable::BEGIN@97 |
98 | 2 | 13µs | 2 | 38µs | # spent 21µs (4+17) within IO::Seekable::BEGIN@98 which was called:
# once (4µs+17µs) by File::Temp::BEGIN@151 at line 98 # spent 21µs making 1 call to IO::Seekable::BEGIN@98
# spent 17µs making 1 call to Exporter::import |
99 | 2 | 13µs | 2 | 6µs | # spent 5µs (3+1) within IO::Seekable::BEGIN@99 which was called:
# once (3µs+1µs) by File::Temp::BEGIN@151 at line 99 # spent 5µs making 1 call to IO::Seekable::BEGIN@99
# spent 1µs making 1 call to strict::import |
100 | 2 | 145µs | 1 | 2.62ms | # spent 2.62ms (1.34+1.28) within IO::Seekable::BEGIN@100 which was called:
# once (1.34ms+1.28ms) by File::Temp::BEGIN@151 at line 100 # spent 2.62ms making 1 call to IO::Seekable::BEGIN@100 |
101 | # XXX we can't get these from IO::Handle or we'll get prototype | ||||
102 | # mismatch warnings on C<use POSIX; use IO::File;> :-( | ||||
103 | 2 | 95µs | 2 | 277µs | # spent 141µs (5+136) within IO::Seekable::BEGIN@103 which was called:
# once (5µs+136µs) by File::Temp::BEGIN@151 at line 103 # spent 141µs making 1 call to IO::Seekable::BEGIN@103
# spent 136µs making 1 call to Exporter::import |
104 | 1 | 200ns | require Exporter; | ||
105 | |||||
106 | 1 | 700ns | our @EXPORT = qw(SEEK_SET SEEK_CUR SEEK_END); | ||
107 | 1 | 8µs | our @ISA = qw(Exporter); | ||
108 | |||||
109 | 1 | 200ns | our $VERSION = "1.48"; | ||
110 | |||||
111 | sub seek { | ||||
112 | @_ == 3 or croak 'usage: $io->seek(POS, WHENCE)'; | ||||
113 | seek($_[0], $_[1], $_[2]); | ||||
114 | } | ||||
115 | |||||
116 | sub sysseek { | ||||
117 | @_ == 3 or croak 'usage: $io->sysseek(POS, WHENCE)'; | ||||
118 | sysseek($_[0], $_[1], $_[2]); | ||||
119 | } | ||||
120 | |||||
121 | sub tell { | ||||
122 | @_ == 1 or croak 'usage: $io->tell()'; | ||||
123 | tell($_[0]); | ||||
124 | } | ||||
125 | |||||
126 | 1 | 3µs | 1; |