Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > ARGF.classクラス

class ARGF.class

クラスの継承リスト: ARGF.class < Object < Kernel < BasicObject
extend: Enumerable

要約

ARGF を表すクラスです。

インスタンスメソッド

定義 説明
argv -> Array

Kernel::ARGV を返します。

binmode -> self

self をバイナリモードにします。一度バイナリモードになった後は非バイナリ モードに戻る事はできません。

binmode? -> bool

ARGF の入力ストリームがバイナリモードなら true を返します。 そうでない場合、false を返します。

bytes { |byte| ... } -> self
bytes -> Enumerator

このメソッドは obsolete です。 代わりに ARGF.class#each_byte を使用してください。 使用すると警告メッセージが表示されます。

chars { |c| ... } -> self
chars -> Enumerator

このメソッドは obsolete です。 代わりに ARGF.class#each_char を使用してください。 使用すると警告メッセージが表示されます。

close -> self

現在開いている処理対象のファイルをクローズします。開くファイルが残って いる場合は次のファイルをオープンします。 ただし、標準入力はクローズされません。

closed? -> bool

現在開いている処理対象のファイルがARGFがcloseされていればtrueを返します。

codepoints { |c| ... } -> self
codepoints -> Enumerator

このメソッドは obsolete です。 代わりに ARGF.class#each_codepoint を使用してください。 使用すると警告メッセージが表示されます。

each(rs = $/) { |line| ... } -> self
each_line(rs = $/) { |line| ... } -> self
each(rs = $/, limit) { |line| ... } -> self
each_line(rs = $/, limit) { |line| ... } -> self
each(rs = $/) -> Enumerator
each_line(rs = $/) -> Enumerator
each(rs = $/, limit) -> Enumerator
each_line(rs = $/, limit) -> Enumerator

ARGFの現在位置から 1 行ずつ文字列として読み込み、それを引数として与えら れたブロックを実行します。

each_byte { |byte| ...} -> self
each_byte -> Enumerator

ARGF の現在位置から 1 バイトずつ読み込み、それを整数として与え、ブロックを実行します。 ブロック引数byteは0..255のいずれかの整数です。

each_char { |c| ... } -> self
each_char -> Enumerator

レシーバに含まれる文字を一文字ずつブロックに渡して評価します。

each_codepoint { |c| ... } -> self
each_codepoint -> Enumerator

self の各コードポイントに対して繰り返しブロックを呼びだします。

eof -> bool
eof? -> bool

現在開いているファイルがEOFに達したらtrueを返します。そうでない場合は falseを返します。

external_encoding -> Encoding

ARGF が処理するファイルに対する外部エンコーディングを返します。 デフォルトは Encoding.default_external です。

file -> IO

現在開いている処理対象の File オブジェクト(または IO オブジェ クト)を返します。

filename -> String
path -> String

現在開いている処理対象のファイル名を返します。

fileno -> Integer
to_i -> Integer

現在オープンしているファイルのファイル記述子を表す整数を返します。

getbyte -> Integer | nil

self から 1 バイト(0..255)を読み込み整数として返します。 既に EOF に達していれば nil を返します。

getc -> String | nil

self から 1 文字読み込んで返します。EOF に到達した時には nil を返します。

gets(rs = $/, chomp: false) -> String | nil
gets(limit, chomp: false) -> String | nil
gets(rs, limit, chomp: false) -> String | nil

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時に は nil を返します。

inplace_mode -> String | nil

ARGF/インプレースエディットモード で書き換えるファイルのバックアップに付加される拡 張子を返します。拡張子が設定されていない場合は空文字列を返します。イン プレースモードでない場合は nil を返します。

inplace_mode=(ext)

ARGF/インプレースエディットモード時にバックアップファイルに付加する拡張子を設定します。 ピリオドも含めて指定する必要があります。

to_s -> String
inspect -> String

常に文字列 "ARGF" を返します。

internal_encoding -> Encoding | nil

ARGF から読み込んだ文字列の内部エンコーディングを返します。 内部エンコーディングが指定されていない場合は nil を返します。

lineno -> Integer

全引数ファイルを一つのファイルとみなしたときの現在の行番号を返します。 個々の引数ファイル毎の行番号を得るには ARGF.file.lineno とします。

lineno=(number)

全引数ファイルを一つのファイルとみなしたときの現在の行番号を number に書き換えます。

lines(rs = $/) { |line| ... } -> self
lines(limit) { |line| ... } -> self
lines(rs, limit) { |line| ... } -> self
lines(rs = $/) -> Enumerator
lines(limit) -> Enumerator
lines(rs, limit) -> Enumerator

このメソッドは obsolete です。 代わりに ARGF.class#each_line を使用してください。 使用すると警告メッセージが表示されます。

pos -> Integer
tell -> Integer

ARGFが現在開いているファイルのファイルポインタの現在の位置をバイト単位 の整数で返します。

pos=(n)

ARGFが開いているファイルのファイルポインタを指定位置に移動します。

print(*arg) -> nil

引数を順に処理対象のファイルに出力します。

printf(format, *arg) -> nil

C 言語の printf と同じように、format に従い引数を 文字列に変換して処理対象のファイルに出力します。

putc(ch) -> object

文字 ch を処理対象のファイルに出力します。 ch を返します。

puts(*arg) -> nil

引数と改行を順番に処理対象のファイルに出力します。 引数がなければ改行のみを出力します。

read(length = nil, str = nil) -> String | nil

ARGVに指定されたファイルを先頭のファイルからlengthバイト読み込み、 その文字列をstrに出力します。読み込んだ文字列を返します。

read_nonblock(maxlen) -> String
read_nonblock(maxlen, outbuf) -> String
read_nonblock(maxlen, outbuf, exception: true) -> String

処理中のファイルからノンブロッキングモードで最大 maxlen バイト読み込みます。 第二の形式では読み込んだデータを outbuf に破壊的に格納してそれを返します。 詳しくは IO#read_nonblock を参照してください。

readbyte -> Integer

自身から 1 バイトを読み込み整数として返します。 既に EOF に達していれば EOFError が発生します。

readchar -> Integer

ARGFから 1 文字読み込んで、その文字に対応する Fixnum を返します。EOF に 到達した時には EOFErrorを発生します。

readline(rs = $/) -> String
readline(limit) -> String
readline(rs, limit) -> String

ARGFの現在位置から一行ずつ文字列として読み込みます。EOF に到達した時に は EOFError を発生します。

readlines(rs = $/) -> Array
readlines(limit) -> Array
readlines(rs, limit) -> Array
to_a(rs = $/) -> Array
to_a(limit) -> Array
to_a(rs, limit) -> Array

ARGFの各行を配列に読み込んで返します。rsがnilの場合は要素に各ファイルを すべて読み込んだ配列を返します。

readpartial(maxlen, outbuf = nil) -> String

IO#readpartialを参照。ARGF.class#read などとは違って複数ファ イルを同時に読み込むことはありません。

rewind -> 0

ARGFが現在開いているファイルのファイルポインタを先頭に戻します。

seek(offset, whence = IO::SEEK_SET) -> 0

ARGFが現在開いているファイルのファイルポインタを whence の位置から offset だけ移動させます。 offset 位置への移動が成功すれば 0 を返します。

set_encoding(ext_enc) -> self
set_encoding(enc_str, options = {}) -> self
set_encoding(ext_enc, int_enc, options = {}) -> self

ARGF の外部/内部エンコーディングを設定します。 次以降に処理するファイルにも同じ設定が適用されます。

skip -> self

現在開いている処理対象のファイルをクローズします。 次回の読み込みは次の引数が処理対象になります。 self を返します。

to_io -> IO

ARGFが現在開いているファイルのFile、またはIOオブジェクトを 返します。

to_write_io -> IO

処理対象のファイルへの書き出し用 IO オブジェクトを返します。

write(str) -> Integer

処理対象のファイルに対して str を出力します。 str が文字列でなければ to_s による文字列化を試みます。 実際に出力できたバイト数を返します。

継承したメソッド

! != __id__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined all? any? chunk chunk_while collect collect_concat count cycle detect drop drop_while each_cons each_entry each_slice each_with_index each_with_object entries find_all find_index first grep grep_v group_by include? inject lazy max max_by min min_by minmax minmax_by none? one? partition reject reverse_each slice_after slice_before slice_when sort sort_by sum take take_while to_h to_set uniq zip !~ <=> == === =~ __send__ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? singleton_class singleton_method singleton_methods taint tainted? tap to_ary to_hash to_int to_proc to_regexp to_str trust untaint untrust untrusted? yield_self .new .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE