.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::InputOutput::ProhibitJoinedReadline 3pm"
.TH Perl::Critic::Policy::InputOutput::ProhibitJoinedReadline 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::InputOutput::ProhibitJoinedReadline \- Use "local $/ = undef" or Path::Tiny instead of joined readline.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
It's really easy to slurp a whole filehandle in at once with \f(CW\*(C`join
q{}, <$fh\*(C'\fR>, but that's inefficient \-\- Perl goes to the trouble of
splitting the file into lines only to have that work thrown away.
.PP
To save performance, either slurp the filehandle without splitting
like so:
.PP
.Vb 1
\&  do { local $/ = undef; <$fh> }
.Ve
.PP
or use Path::Tiny, which is even faster.
.PP
\&\fBNote\fR that if the \f(CW\*(C`ProhibitPunctuationVars\*(C'\fR policy is also in effect,
it will complain about the use of \f(CW$/\fR in the line above.  In that
case, write this instead:
.PP
.Vb 1
\&  use English \*(Aq\-no_match_vars\*(Aq;
\&
\&  do { local $INPUT_RECORD_SEPARATOR = undef; <$fh> };
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH CAVEATS
.IX Header "CAVEATS"
Due to a bug in the current version of PPI (v1.119_03) and earlier,
the readline operator is often misinterpreted as less-than and
greater-than operators after a comma.  Therefore, this policy only
works well on the empty filehandle, \f(CW\*(C`<>\*(C'\fR.  When PPI is fixed,
this should just start working.
.SH CREDITS
.IX Header "CREDITS"
Initial development of this policy was supported by a grant from the
Perl Foundation.
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2021 Chris Dolan.  Many rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module