Debian Codegraph @

upstream/opensuse-tumbleweed/man3/PerlIO::scalar.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "PerlIO::scalar 3pm"
61 .TH PerlIO::scalar 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 PerlIO::scalar \- in\-memory IO, scalar IO
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 5
71 \& my $scalar = \*(Aq\*(Aq;
72 \& ...
73 \& open my $fh, "<", \e$scalar or die;
74 \& open my $fh, ">", \e$scalar or die;
75 \& open my $fh, ">>", \e$scalar or die;
76 .Ve
77 .PP
78 or
79 .PP
80 .Vb 5
81 \& my $scalar = \*(Aq\*(Aq;
82 \& ...
83 \& open my $fh, "<:scalar", \e$scalar or die;
84 \& open my $fh, ">:scalar", \e$scalar or die;
85 \& open my $fh, ">>:scalar", \e$scalar or die;
86 .Ve
87 .SH DESCRIPTION
88 .IX Header "DESCRIPTION"
89 A filehandle is opened but the file operations are performed "in\-memory"
90 on a scalar variable. All the normal file operations can be performed
91 on the handle. The scalar is considered a stream of bytes. Currently
92 fileno($fh) returns \-1.
93 .PP
94 Attempting to open a read\-only scalar for writing will fail, and if
95 warnings are enabled, produce a warning.
96 .SH "IMPLEMENTATION NOTE"
97 .IX Header "IMPLEMENTATION NOTE"
98 \&\f(CW\*(C`PerlIO::scalar\*(C'\fR only exists as a stub. One does not need to explicitly
99 \&\f(CW\*(C`use PerlIO::scalar\*(C'\fR.