Type:
Class

ARGF is a stream designed for use in scripts that process files given as command-line arguments or passed in via STDIN.

The arguments passed to your script are stored in the ARGV Array, one argument per element. ARGF assumes that any arguments that aren't filenames have been removed from ARGV. For example:

$ ruby argf.rb --verbose file1 file2

ARGV  #=> ["--verbose", "file1", "file2"]
option = ARGV.shift #=> "--verbose"
ARGV  #=> ["file1", "file2"]

You can now use ARGF to work with a concatenation of each of these named files. For instance, ARGF.read will return the contents of file1 followed by the contents of file2.

After a file in ARGV has been read ARGF removes it from the Array. Thus, after all files have been read ARGV will be empty.

You can manipulate ARGV yourself to control what ARGF operates on. If you remove a file from ARGV, it is ignored by ARGF; if you add files to ARGV, they are treated as if they were named on the command line. For example:

ARGV.replace ["file1"]
ARGF.readlines # Returns the contents of file1 as an Array
ARGV           #=> []
ARGV.replace ["file2", "file3"]
ARGF.read      # Returns the contents of file2 and file3

If ARGV is empty, ARGF acts as if it contained STDIN, i.e. the data piped to your script. For example:

$ echo "glark" | ruby -e 'p ARGF.read'
"glark\n"
readbyte

ARGF.readbyte â Fixnum Instance Public methods Reads the next 8-bit byte from

2015-03-30 12:51:59
file

ARGF.file â IO or File object Instance Public methods Returns the current

2015-03-30 11:24:30
external_encoding

ARGF.external_encoding â encoding Instance Public methods

2015-03-30 11:19:43
each

ARGF.each(sep=$/) {|line| block } â ARGFARGF.each(sep=$/,limit) {|line| block } â ARGFARGF.each(...)

2015-03-30 10:51:04
putc

ios.putc(obj) â obj Instance Public methods If obj is Numeric

2015-03-30 12:36:25
each_codepoint

ARGF.each_codepoint {|codepoint| block } â ARGFARGF.each_codepoint â an_enumerator Instance

2015-03-30 11:04:05
codepoints

codepoints() Instance Public methods This is a deprecated alias for e

2015-03-30 10:50:04
getbyte

ARGF.getbyte â Fixnum or nil Instance Public methods Gets the next 8-bit byte

2015-03-30 11:28:53
inplace_mode=

ARGF.inplace_mode = ext â ARGF Instance Public methods

2015-03-30 11:42:37
readlines

ARGF.readlines(sep=$/) â arrayARGF.readlines(limit) â arrayARGF.readlines(sep, limit) â array

2015-03-30 13:08:15