2
2
3
3
= TITLE class IO::Special
4
4
5
- = SUBTITLE Represent a Standard I/O device
5
+ = SUBTITLE Path to Special I/O device
6
6
7
- This provides a similar interface for the special standard input and output
8
- handles C < $*IN > , C < $*OUT > and C < $*ERR > to that of L < IO::Path|/type/IO::Path >
9
- for regular files. It is typically returned by the L < path method|/type/IO::Handle#method_path >
10
- of those handles so that they can be used interchangeably with the handles of
11
- regular files.
7
+ Used as a L « C < $.path > |/type/IO::Handle#method_path>» attribute in special
8
+ standard input and output handles C < $*IN > , C < $*OUT > and C < $*ERR > . Provides
9
+ abridged interface of L « C < IO::Handle > |/type/IO::Handle» , mostly file tests
10
+ and stringification.
12
11
13
12
= head1 Methods
14
13
@@ -17,29 +16,28 @@ regular files.
17
16
= for code :skip-test
18
17
method new(:$!what!)
19
18
20
- The constructor has a single required named argument C < what > that will be
21
- '<STDIN>', '<STDOUT>' or '<STDERR>' as appropriate. It is unlikely that you
22
- will ever need to construct one of these objects yourself however as it
19
+ The constructor has a single required named argument C < : what> that will be
20
+ C « '<STDIN>' » , C « '<STDOUT>' » , or C « '<STDERR>' » , as appropriate. It is unlikely
21
+ that you will ever need to construct one of these objects yourself however as it
23
22
will be done for you when the special handles are initialised.
24
23
25
24
= head2 method WHICH
26
25
27
26
method WHICH(IO::Special:D: --> Str)
28
27
29
- This returns a string which identifies the object.
28
+ This returns a string that identifies the object.
30
29
31
30
= head2 method Str
32
31
33
32
method Str(IO::Special:D:)
34
33
35
- This returns '<STDIN>', '<STDOUT>' or '<STDERR>' as appropriate.
34
+ This returns C « '<STDIN>' » , C « '<STDOUT>' » , or C « '<STDERR>' » as appropriate.
36
35
37
36
= head2 method IO
38
37
39
38
method IO(IO::Special:D: --> IO::Special)
40
39
41
- This returns the C < IO::Special > object, it is provided for
42
- conformance to the C < IO::Path > interface.
40
+ Returns the invocant.
43
41
44
42
= head2 method e
45
43
@@ -63,7 +61,7 @@ The 'file' file test operator, always returns C<False>.
63
61
64
62
method s(IO::Special:D: --> Int)
65
63
66
- The 'size' file test operator, always returns 0 .
64
+ The 'size' file test operator, always returns C < 0 > .
67
65
68
66
= head2 method l
69
67
@@ -86,31 +84,32 @@ The 'write access' file test operator, returns C<True> if this is
86
84
the standard output or standard error handle, C < False > if it is
87
85
the standard input.
88
86
89
-
90
87
= head2 method x
91
88
92
89
method x(IO::Special:D: --> Bool)
93
90
94
91
The 'execute access' file test operator, always returns C < False > .
95
92
96
-
97
93
= head2 method modified
98
94
99
95
method modified(IO::Special:D: --> Instant)
100
96
101
- The last modified time always returns an undefined L < Instant > .
97
+ The last modified time always returns an L « C < Instant > |/type/Instant» type
98
+ object.
102
99
103
100
= head2 method accessed
104
101
105
102
method accessed(IO::Special:D: --> Instant)
106
103
107
- The last accessed time always returns an undefined L < Instant >
104
+ The last accessed time always returns an L « C < Instant > |/type/Instant» type
105
+ object.
108
106
109
107
= head2 method changed
110
108
111
109
method changed(IO::Special:D: --> Instant)
112
110
113
- The last changed time always returns an undefined L < Instant >
111
+ The last changed time always returns an L « C < Instant > |/type/Instant» type
112
+ object.
114
113
115
114
= head2 method mode
116
115
0 commit comments