検索結果

StringIO#lines(rs = $/) {|line| ... } -> self (22.0)

• 2.2.0

• インスタンスメソッド

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

自身から 1 行ずつ読み込み、それを引数として与えられたブロックを実行します。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。

@raise IOError 自身が読み取り不可なら発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\n")
a.each{|l| p l }
#=> "hoge\n"
# "foo\n"
//}

@see $/
...

• StringIO

StringIO#pos=(n) (22.0)

• 2.2.0

• インスタンスメソッド

自身の位置を n に移動します。自身が表す文字列のサイズより大きくても構いません。

自身の位置を n に移動します。自身が表す文字列のサイズより大きくても構いません。

@param n 自身の位置を整数で指定します。

@raise Errno::EINVAL n がマイナスである場合に発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge", 'r+')
a.pos = 10
a << 'Z'
a.string #=> "hoge\000\000\000\000\000\000Z"
//}

• StringIO

StringIO#print() -> nil (22.0)

• 2.2.0

• インスタンスメソッド

自身に引数を順に出力します。引数を省略した場合は、$_ を出力します。 引数の扱いは Kernel.#print を参照して下さい。

自身に引数を順に出力します。引数を省略した場合は、$_ を出力します。
引数の扱いは Kernel.#print を参照して下さい。

@param obj 書き込みたいオブジェクトを指定します。

@raise IOError 自身が書き込み用にオープンされていなければ発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("", 'r+')
a.print("hoge", "bar", "foo")
a.string #=> "hogebarfoo"
//}

• StringIO

StringIO#print(*obj) -> nil (22.0)

• 2.2.0

• インスタンスメソッド

自身に引数を順に出力します。引数を省略した場合は、$_ を出力します。 引数の扱いは Kernel.#print を参照して下さい。

自身に引数を順に出力します。引数を省略した場合は、$_ を出力します。
引数の扱いは Kernel.#print を参照して下さい。

@param obj 書き込みたいオブジェクトを指定します。

@raise IOError 自身が書き込み用にオープンされていなければ発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("", 'r+')
a.print("hoge", "bar", "foo")
a.string #=> "hogebarfoo"
//}

• StringIO

StringIO#printf(format, *obj) -> nil (22.0)

• 2.2.0

• インスタンスメソッド

指定されたフォーマットに従い各引数 obj を文字列に変換して、自身に出力します。

指定されたフォーマットに従い各引数 obj を文字列に変換して、自身に出力します。

@param format 文字列のフォーマットを指定します。Kernel.#format を参照して下さい。

@param obj 書き込みたいオブジェクトを指定します。

@raise IOError 自身が書き込み用にオープンされていなければ発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("", 'r+')
a.printf("%c%c%c", 97, 98, 99)
a.string ...

• StringIO

絞り込み条件を変える

StringIO#puts(*obj) -> nil (22.0)

• 2.2.0

• インスタンスメソッド

obj と改行を順番に自身に出力します。引数がなければ改行のみを出力します。 詳しい仕様は Kernel.#puts を参照して下さい。

obj と改行を順番に自身に出力します。引数がなければ改行のみを出力します。
詳しい仕様は Kernel.#puts を参照して下さい。

@param obj 書き込みたいオブジェクトを指定します。

@raise IOError 自身が書き込み用にオープンされていなければ発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("", 'r+')
a.puts("hoge", "bar", "foo")
a.string #=> "hoge\nbar\nfoo\n"
//}

• StringIO

StringIO#readbyte -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

自身から 1 文字読み込んで、その文字に対応する整数を返します。

自身から 1 文字読み込んで、その文字に対応する整数を返します。

文字列の終端に到達した時には例外 EOFError を発生させます。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge")
a.readbyte #=> 104
//}

@raise EOFError 文字列の終端に到達した時に発生します。

• EOFError
• StringIO

StringIO#readchar -> String (22.0)

• 2.2.0

• インスタンスメソッド

自身から 1 文字読み込んで、その文字に対応する String を返します。

自身から 1 文字読み込んで、その文字に対応する String を返します。

文字列の終端に到達した時には例外 EOFError を発生させます。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge")
a.readchar #=> "h"
//}

@raise EOFError EOFに達した時発生する

• EOFError
• StringIO

StringIO#readline(rs = $/) -> String (22.0)

• 2.2.0

• インスタンスメソッド

自身から 1 行読み込んで、その文字列を返します。

自身から 1 行読み込んで、その文字列を返します。

文字列の終端に到達した時には、例外 EOFError を発生させます。
IO#readline と違い読み込んだ文字列を変数 $_ にセットしません。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。

@raise EOFError 文字列の終端に到達した時に発生します。

@raise IOError 自身が読み込み用にオープンされていなければ発生します。

//emlist[例][rub...

• StringIO

StringIO#readlines(rs = $/) -> [String] (22.0)

• 2.2.0

• インスタンスメソッド

自身からデータを全て読み込んで、その各行を要素としてもつ配列を返します。 既に文字列の終端に達していれば空配列 [] を返します。

自身からデータを全て読み込んで、その各行を要素としてもつ配列を返します。
既に文字列の終端に達していれば空配列 [] を返します。

@param rs 行の区切りを文字列で指定します。rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします(パラグラフモード)。

@raise IOError 自身が読み込み用にオープンされていなければ発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge\nfoo\nbar\n")
a.readlines ...

• StringIO

絞り込み条件を変える

StringIO#string -> String (22.0)

• 2.2.0

• インスタンスメソッド

自身が表す文字列を返します。

自身が表す文字列を返します。

返されるのは生成時に与えられたバッファとして使われている文字列です。
文字列は複製されないことに注意して下さい。

//emlist[例][ruby]{
require "stringio"
sio = StringIO.new
sio << "abc"
s = sio.string
p s #=> "abc"
sio << "xyz"
p s #=> "abcxyz"
//}

• StringIO

StringIO#truncate(len) -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

自身のサイズが len になるように、自身を切り詰め、もしくは拡大します。 拡大した場合は、その部分を 0 で埋めます。 len を返します。

自身のサイズが len になるように、自身を切り詰め、もしくは拡大します。
拡大した場合は、その部分を 0 で埋めます。
len を返します。

@param len 変更したいサイズを整数で指定します。

@raise IOError 自身が書き込み可能でない時に発生します。

@raise Errno::EINVAL len がマイナスの時に発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge", 'r+')
a.truncate(2)
a.string #=>...

• StringIO

StringIO#write(obj) -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

自身に obj を書き込みます。obj が文字列でなければ to_s による文字列化を試みます。 書き込まれた文字列の長さを返します。

自身に obj を書き込みます。obj が文字列でなければ to_s による文字列化を試みます。
書き込まれた文字列の長さを返します。

全ての出力メソッドは、最終的に「write」という名のメソッドを呼び出すので、
このメソッドを置き換えることで出力関数の挙動を変更することができます。

@param obj 書き込みたいオブジェクトを指定します。

@raise IOError 自身が書き込み可能でない時に発生します。

//emlist[例][ruby]{
require "stringio"
a = StringIO.new("hoge", 'r+')
a.write("aaa") ...

• StringIO

StringScanner#[](nth) -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

前回マッチした正規表現の nth 番目のかっこに対応する部分文字列を 返します。インデックス 0 はマッチした部分全体です。前回のマッチが 失敗していると常に nil を返します。

前回マッチした正規表現の nth 番目のかっこに対応する部分文字列を
返します。インデックス 0 はマッチした部分全体です。前回のマッチが
失敗していると常に nil を返します。

@param nth 前回マッチした正規表現の nth 番目のかっこに対応する部分文字列を
返します。


//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan(/\w(\w)(\w*)/) # => "test"
s[0] # => "test"...

• StringScanner

StringScanner#beginning_of_line? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタが行頭を指しているなら true を、 行頭以外を指しているなら false を返します。

スキャンポインタが行頭を指しているなら true を、
行頭以外を指しているなら false を返します。

行頭の定義は、文字列先頭かまたは \n の直後を指していることです。
文字列末尾は必ずしも行頭ではありません。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new("test\nstring")
s.bol? # => true
s.scan(/\w+/)
s.bol? # => false
s.scan(/\n/)
s.bol? # => true
s.scan(/\w+/...

• StringScanner

絞り込み条件を変える

StringScanner#bol? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタが行頭を指しているなら true を、 行頭以外を指しているなら false を返します。

スキャンポインタが行頭を指しているなら true を、
行頭以外を指しているなら false を返します。

行頭の定義は、文字列先頭かまたは \n の直後を指していることです。
文字列末尾は必ずしも行頭ではありません。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new("test\nstring")
s.bol? # => true
s.scan(/\w+/)
s.bol? # => false
s.scan(/\n/)
s.bol? # => true
s.scan(/\w+/...

• StringScanner

StringScanner#charpos -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

現在のスキャンポインタのインデックスを文字単位で返します。

現在のスキャンポインタのインデックスを文字単位で返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new("abcädeföghi")
s.charpos # => 0
s.scan_until(/ä/) # => "abcä"
s.pos # => 5
s.charpos # => 4
//}

@see StringScanner#pos

• StringScanner

StringScanner#check(regexp) -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

現在位置から regexp とのマッチを試みます。 マッチに成功したらマッチした部分文字列を返します。 マッチに失敗したら nil を返します。

現在位置から regexp とのマッチを試みます。
マッチに成功したらマッチした部分文字列を返します。
マッチに失敗したら nil を返します。

このメソッドはマッチが成功してもスキャンポインタを進めません。

@param regexp マッチに用いる正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.check(/\w+/) # => "test"
s.pos # => 0
s.matched # => "test"
s.check(...

• StringScanner

StringScanner#check_until(regexp) -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

regexp が一致するまで文字列をスキャンします。 マッチに成功したらスキャン開始位置からマッチ部分の末尾までの部分文字列を返します。 マッチに失敗したら nil を返します。

regexp が一致するまで文字列をスキャンします。
マッチに成功したらスキャン開始位置からマッチ部分の末尾までの部分文字列を返します。
マッチに失敗したら nil を返します。

このメソッドはマッチが成功してもスキャンポインタを進めません。

@param regexp マッチに用いる正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.check_until(/str/) # => "test str"
s.matched # => "str...

• StringScanner

StringScanner#clear -> self (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタを文字列末尾後まで進め、マッチ記録を捨てます。

スキャンポインタを文字列末尾後まで進め、マッチ記録を捨てます。

@return self を返します。

pos = self.string.size と同じ動作です。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan(/\w+/) # => "test"
s.matched # => "test"
s.pos # => 4
s[0] # => "test"
s.terminate
s.matched # => nil
s[0]...

• StringScanner

絞り込み条件を変える

StringScanner#empty? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタが文字列の末尾を指しているなら true を、 末尾以外を指しているなら false を返します。

スキャンポインタが文字列の末尾を指しているなら true を、
末尾以外を指しているなら false を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.eos? # => false
s.scan(/\w+/)
s.scan(/\s+/)
s.scan(/\w+/)
s.eos? # => true
//}

StringScanner#empty? は将来のバージョンで削除される予定です。
代わりに StringScanner#eos? を使って...

• StringScanner

StringScanner#eos? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタが文字列の末尾を指しているなら true を、 末尾以外を指しているなら false を返します。

スキャンポインタが文字列の末尾を指しているなら true を、
末尾以外を指しているなら false を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.eos? # => false
s.scan(/\w+/)
s.scan(/\s+/)
s.scan(/\w+/)
s.eos? # => true
//}

StringScanner#empty? は将来のバージョンで削除される予定です。
代わりに StringScanner#eos? を使って...

• StringScanner

StringScanner#exist?(regexp) -> Integer | nil (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタの位置から，次にマッチする文字列の末尾までの長さを返します。

スキャンポインタの位置から，次にマッチする文字列の末尾までの長さを返します。

マッチに失敗したら nil を返します。

このメソッドはマッチが成功してもスキャンポインタを進めません。

@param regexp マッチに用いる正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.exist?(/s/) # => 3
s.exist?(//) # => 0
s.scan(/\w+/) # => "test"
s.exist?(/s/) # => 2
s.exis...

• StringScanner

StringScanner#get_byte -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

1 バイトスキャンして文字列で返します。 スキャンポインタをその後ろに進めます。 スキャンポインタが文字列の末尾を指すなら nil を返します。

1 バイトスキャンして文字列で返します。
スキャンポインタをその後ろに進めます。
スキャンポインタが文字列の末尾を指すなら nil を返します。

StringScanner#getbyte は将来のバージョンで削除される予定です。
代わりに StringScanner#get_byte を使ってください。

//emlist[例][ruby]{
require 'strscan'

utf8 = "\u{308B 3073 3044}"
s = StringScanner.new(utf8.encode("EUC-JP"))
p s.get_byte #=> "\xA4"
p ...

• StringScanner

StringScanner#getbyte -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

1 バイトスキャンして文字列で返します。 スキャンポインタをその後ろに進めます。 スキャンポインタが文字列の末尾を指すなら nil を返します。

1 バイトスキャンして文字列で返します。
スキャンポインタをその後ろに進めます。
スキャンポインタが文字列の末尾を指すなら nil を返します。

StringScanner#getbyte は将来のバージョンで削除される予定です。
代わりに StringScanner#get_byte を使ってください。

//emlist[例][ruby]{
require 'strscan'

utf8 = "\u{308B 3073 3044}"
s = StringScanner.new(utf8.encode("EUC-JP"))
p s.get_byte #=> "\xA4"
p ...

• StringScanner

絞り込み条件を変える

StringScanner#getch -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

一文字スキャンして文字列で返します。 スキャンポインタをその後ろに進めます。 スキャンポインタが文字列の末尾を指すならnilを返します。

一文字スキャンして文字列で返します。
スキャンポインタをその後ろに進めます。
スキャンポインタが文字列の末尾を指すならnilを返します。

一文字の定義は、与えた文字列のエンコードに依存します。

//emlist[例][ruby]{
require 'strscan'

utf8 = "\u{308B 3073 3044}"
s = StringScanner.new(utf8.encode("UTF-8"))
p s.getch # => "る"
p s.getch # => "び"
p s....

• StringScanner

StringScanner#inspect -> String (22.0)

• 2.2.0

• インスタンスメソッド

StringScannerオブジェクトを表す文字列を返します。

StringScannerオブジェクトを表す文字列を返します。

文字列にはクラス名の他、以下の情報が含まれます。

* スキャナポインタの現在位置。
* スキャン対象の文字列の長さ。
* スキャンポインタの前後にある文字。上記実行例の @ がスキャンポインタを表します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.inspect # => "#<StringScanner 0/11 @ \"test .....

• StringScanner

StringScanner#matched -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

前回マッチした部分文字列を返します。 前回のマッチに失敗していると nil を返します。

前回マッチした部分文字列を返します。
前回のマッチに失敗していると nil を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.matched # => nil
s.scan(/\w+/) # => "test"
s.matched # => "test"
s.scan(/\w+/) # => nil
s.matched # => nil
s.scan(/\s+/) # => " "
s.matched # => " "
//}

• StringScanner

StringScanner#matched? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

前回のマッチが成功していたら true を、 失敗していたら false を返します。

前回のマッチが成功していたら true を、
失敗していたら false を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.matched? # => false
s.scan(/\w+/) # => "test"
s.matched? # => true
s.scan(/\w+/) # => nil
s.matched? # => false
s.scan(/\s+/) # => " "
s.matched? # => true
//}

• StringScanner

StringScanner#pointer -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

現在のスキャンポインタのインデックスを返します。

現在のスキャンポインタのインデックスを返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.pos # => 0
s.scan(/\w+/) # => "test"
s.pos # => 4
s.scan(/\w+/) # => nil
s.pos # => 4
s.scan(/\s+/) # => " "
s.pos # => 5
//}

@see StringScanner#charpos

• StringScanner

絞り込み条件を変える

StringScanner#pointer=(n) (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタのインデックスを n にセットします。

スキャンポインタのインデックスを n にセットします。

@param n 整数で、バイト単位で指定します。
負数を指定すると文字列の末尾からのオフセットとして扱います。
@raise RangeError マッチ対象の文字列の長さを超える値を指定すると発生します。

@return n を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.scan(/\w+/) # => "test"
p s.pos = 1 # => 1
p s.scan(/\...

• StringScanner

StringScanner#pos -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

現在のスキャンポインタのインデックスを返します。

現在のスキャンポインタのインデックスを返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.pos # => 0
s.scan(/\w+/) # => "test"
s.pos # => 4
s.scan(/\w+/) # => nil
s.pos # => 4
s.scan(/\s+/) # => " "
s.pos # => 5
//}

@see StringScanner#charpos

• StringScanner

StringScanner#pos=(n) (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタのインデックスを n にセットします。

スキャンポインタのインデックスを n にセットします。

@param n 整数で、バイト単位で指定します。
負数を指定すると文字列の末尾からのオフセットとして扱います。
@raise RangeError マッチ対象の文字列の長さを超える値を指定すると発生します。

@return n を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.scan(/\w+/) # => "test"
p s.pos = 1 # => 1
p s.scan(/\...

• StringScanner

StringScanner#post_match -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

前回マッチを行った文字列のうち、マッチしたところよりも後ろの 部分文字列を返します。前回のマッチが失敗していると常に nil を 返します。

前回マッチを行った文字列のうち、マッチしたところよりも後ろの
部分文字列を返します。前回のマッチが失敗していると常に nil を
返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.post_match # => nil
s.scan(/\w+/) # => "test"
s.post_match # => " string"
s.scan(/\w+/) # => nil
s.post_match # => nil
s.scan(/\s+/) # => " "
s.post...

• StringScanner

StringScanner#pre_match -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

前回マッチを行った文字列のうち、マッチしたところよりも前の 部分文字列を返します。前回のマッチが失敗していると常に nil を 返します。

前回マッチを行った文字列のうち、マッチしたところよりも前の
部分文字列を返します。前回のマッチが失敗していると常に nil を
返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.pre_match # => nil
s.scan(/\w+/) # => "test"
s.pre_match # => ""
s.scan(/\w+/) # => nil
s.pre_match # => nil
s.scan(/\s+/) # => " "
s.pre_match ...

• StringScanner

絞り込み条件を変える

StringScanner#reset -> self (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタを文字列の先頭 (インデックス 0) に戻し、 マッチ記録を捨てます。

スキャンポインタを文字列の先頭 (インデックス 0) に戻し、
マッチ記録を捨てます。

pos = 0と同じ動作です。

@return self を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan(/\w+/) # => "test"
s.matched # => "test"
s.pos # => 4
s[0] # => "test"
s.reset
s.matched # => nil
s[0] ...

• StringScanner

StringScanner#rest -> String (22.0)

• 2.2.0

• インスタンスメソッド

文字列の残り (rest) を返します。 具体的には、スキャンポインタが指す位置からの文字列を返します。

文字列の残り (rest) を返します。
具体的には、スキャンポインタが指す位置からの文字列を返します。

スキャンポインタが文字列の末尾を指していたら空文字列 ("") を返します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.rest # => "test string"
s.scan(/\w+/) # => "test"
s.rest # => " string"
s.scan(/\s+/) # => " "
s.rest #...

• StringScanner

StringScanner#rest? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

文字列が残っているならば trueを、 残っていないならば false を返します。

文字列が残っているならば trueを、
残っていないならば false を返します。

StringScanner#eos? と逆の結果を返します。

StringScanner#rest? は将来のバージョンで削除される予定です。
代わりに StringScanner#eos? を使ってください。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.eos? # => false
p s.rest? # => true
s.scan(/\w+/)
s.scan...

• StringScanner

StringScanner#rest_size -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

文字列の残りの長さを返します。 stringscanner.rest.size と同じです。

文字列の残りの長さを返します。
stringscanner.rest.size と同じです。

StringScanner#restsize は将来のバージョンで削除される予定です。
代わりにStringScanner#rest_size を使ってください。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.rest_size # => 11
p s.rest.size # => 11
//}

• StringScanner

StringScanner#restsize -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

文字列の残りの長さを返します。 stringscanner.rest.size と同じです。

文字列の残りの長さを返します。
stringscanner.rest.size と同じです。

StringScanner#restsize は将来のバージョンで削除される予定です。
代わりにStringScanner#rest_size を使ってください。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.rest_size # => 11
p s.rest.size # => 11
//}

• StringScanner

絞り込み条件を変える

StringScanner#scan(regexp) -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタの地点だけで regexp と文字列のマッチを試します。 マッチしたら、スキャンポインタを進めて正規表現にマッチした 部分文字列を返します。マッチしなかったら nil を返します。

スキャンポインタの地点だけで regexp と文字列のマッチを試します。
マッチしたら、スキャンポインタを進めて正規表現にマッチした
部分文字列を返します。マッチしなかったら nil を返します。

@param regexp マッチに用いる正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.scan(/\w+/) #=> "test"
p s.scan(/\w+/) #=> nil
p s.scan(/\s+/) #=> " "
p s.scan(/...

• StringScanner

StringScanner#scan_full(regexp, s, f) -> object (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタの位置から regexp と文字列のマッチを試します。

スキャンポインタの位置から regexp と文字列のマッチを試します。

マッチに成功すると、s と f の値によって以下のように動作します。

* s が true ならばスキャンポインタを進めます。
* s が false ならばスキャンポインタを進めません。
* f が true ならばマッチした部分文字列を返します。
* f が false ならばマッチした部分文字列の長さを返します。

マッチに失敗すると s や f に関係なく nil を返します。

このメソッドは s と f の組み合わせにより、
他のメソッドと同等の動作になります。

*...

• StringScanner

StringScanner#scan_until(regexp) -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

regexp で指定された正規表現とマッチするまで文字列をスキャンします。 マッチに成功したらスキャンポインタを進めて、 スキャン開始位置からマッチ部分の末尾までの部分文字列を返します。 マッチに失敗したら nil を返します。

regexp で指定された正規表現とマッチするまで文字列をスキャンします。
マッチに成功したらスキャンポインタを進めて、
スキャン開始位置からマッチ部分の末尾までの部分文字列を返します。
マッチに失敗したら nil を返します。

@param regexp マッチに用いる正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan_until(/str/) # => "test str"
s.matched # => "str"
s.pos ...

• StringScanner

StringScanner#search_full(regexp, s, f) -> object (22.0)

• 2.2.0

• インスタンスメソッド

regexp で指定された正規表現とマッチするまで文字列をスキャンします。

regexp で指定された正規表現とマッチするまで文字列をスキャンします。

マッチに成功すると、s と f の値によって以下のように動作します。

* s が true ならばスキャンポインタを進めます。
* s が false ならばスキャンポインタを進めません。
* f が true ならばスキャン開始位置からマッチした部分の末尾までの部分文字列を返します。
* f が false ならばスキャン開始位置からマッチした部分の末尾までの部分文字列の長さを返します。

マッチに失敗すると s や f に関係なく nil を返します。

このメソッドは s と ...

• StringScanner

StringScanner#skip(regexp) -> Integer | nil (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタの地点だけで regexp と文字列のマッチを試します。 マッチしたらスキャンポインタを進めマッチした部分文字列の 長さを返します。マッチしなかったら nil を返します。

スキャンポインタの地点だけで regexp と文字列のマッチを試します。
マッチしたらスキャンポインタを進めマッチした部分文字列の
長さを返します。マッチしなかったら nil を返します。

@param regexp マッチに使用する正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
p s.skip(/\w+/) #=> 4
p s.skip(/\w+/) #=> nil
p s.skip(/\s+/) #=> 1
p s.skip(/\w+/) #=...

• StringScanner

絞り込み条件を変える

StringScanner#skip_until(regexp) -> Integer | nil (22.0)

• 2.2.0

• インスタンスメソッド

regexp が一致するまで文字列をスキャンします。 マッチに成功したらスキャンポインタを進めて、 スキャン開始位置からマッチ部分の末尾までの部分文字列の長さを返します。 マッチに失敗したら nil を返します。

regexp が一致するまで文字列をスキャンします。
マッチに成功したらスキャンポインタを進めて、
スキャン開始位置からマッチ部分の末尾までの部分文字列の長さを返します。
マッチに失敗したら nil を返します。

@param regexp マッチに使用する正規表現を指定します。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan_until(/str/) # => 8
s.matched # => "str"
s.pos # =>...

• StringScanner

StringScanner#string=(str) (22.0)

• 2.2.0

• インスタンスメソッド

スキャン対象の文字列を str に変更して、マッチ記録を捨てます。

スキャン対象の文字列を str に変更して、マッチ記録を捨てます。

@param str スキャン対象の文字列を str に変更して、マッチ記録を捨てます。

@return str を返します。

//emlist[例][ruby]{
require 'strscan'

str = '0123'
s = StringScanner.new('test string')
s.string = str # => "0123"
s.scan(/\w+/) # => "0123"
//}

• StringScanner

StringScanner#terminate -> self (22.0)

• 2.2.0

• インスタンスメソッド

スキャンポインタを文字列末尾後まで進め、マッチ記録を捨てます。

スキャンポインタを文字列末尾後まで進め、マッチ記録を捨てます。

@return self を返します。

pos = self.string.size と同じ動作です。

//emlist[例][ruby]{
require 'strscan'

s = StringScanner.new('test string')
s.scan(/\w+/) # => "test"
s.matched # => "test"
s.pos # => 4
s[0] # => "test"
s.terminate
s.matched # => nil
s[0]...

• StringScanner

Struct#equal?(other) -> bool (22.0)

• 2.2.0

• インスタンスメソッド

指定された other が self 自身である場合のみ真を返します。 これは Object クラスで定義されたデフォルトの動作で す。

指定された other が self 自身である場合のみ真を返します。
これは Object クラスで定義されたデフォルトの動作で
す。

[注意] 本メソッドの記述は Struct の下位クラスのインスタンスに対して呼び
出す事を想定しています。Struct.new は Struct の下位クラスを作成する点に
注意してください。


@see Struct#eql?, Struct#==

• Object
• Struct

TCPServer#accept -> TCPSocket (22.0)

• 2.2.0

• インスタンスメソッド

クライアントからの接続要求を受け付け、接続した TCPSocket のインスタンスを返します。

クライアントからの接続要求を受け付け、接続した
TCPSocket のインスタンスを返します。

例:

require 'socket'

TCPServer.open("", 0) {|serv|
c = TCPSocket.new(*serv.addr.values_at(3,1))
s = serv.accept
c.write "foo"
p s.recv(10) #=> "foo"
}

• TCPServer
• TCPSocket

絞り込み条件を変える

TCPServer#sysaccept -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

接続したクライアントのソケットをファイル記述子で返すことを除けば TCPServer#accept と同じです。

接続したクライアントのソケットをファイル記述子で返すことを除けば
TCPServer#accept と同じです。

例:

require 'socket'

TCPServer.open("", 0) {|serv|
c = TCPSocket.new(*serv.addr.values_at(3,1))
p serv.sysaccept #=> 6
}

• TCPServer

Tempfile#delete -> self (22.0)

• 2.2.0

• インスタンスメソッド

テンポラリファイルをクローズせずに、削除します。 UNIXライクなシステムでは、 作成したテンポラリファイルが他のプログラムに使用される機会をなくすために、 テンポラリファイルを作成しオープンした後、 すぐに削除するということがしばしばおこなわれます。

テンポラリファイルをクローズせずに、削除します。
UNIXライクなシステムでは、
作成したテンポラリファイルが他のプログラムに使用される機会をなくすために、
テンポラリファイルを作成しオープンした後、
すぐに削除するということがしばしばおこなわれます。


require "tempfile"
tf = Tempfile.new("foo")
tf.unlink
p tf.path # => nil
tf.print("foobar,hoge\n")
tf.rewind
p tf.gets("\n") # => "foobar,hoge\n"

• Tempfile

Tempfile#length -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

テンポラリファイルのサイズを返します。

テンポラリファイルのサイズを返します。

require "tempfile"
tf = Tempfile.new("foo")
tf.print("bar,ugo")
p tf.size # => 7
tf.close
p tf.size # => 7

• Tempfile

Tempfile#open -> self (22.0)

• 2.2.0

• インスタンスメソッド

クローズしたテンポラリファイルを再オープンします。 "r+" でオープンされるので、クローズ前の内容を再度読む ことができます。

クローズしたテンポラリファイルを再オープンします。
"r+" でオープンされるので、クローズ前の内容を再度読む
ことができます。

require "tempfile"
tf = Tempfile.new("foo")
tf.print("foobar,hoge\n")
tf.print("bar,ugo\n")
tf.close
tf.open
p tf.gets # => "foobar,hoge\n"

• Tempfile

Tempfile#path -> String | nil (22.0)

• 2.2.0

• インスタンスメソッド

テンポラリファイルのパス名を返します。

テンポラリファイルのパス名を返します。

Tempfile#close! を実行後だった場合にはnilを返します。

require "tempfile"
tf = Tempfile.new("hoo")
p tf.path # => "/tmp/hoo.10596.0"
tf.close!
p tf.path # => nil

• Tempfile

絞り込み条件を変える

Tempfile#size -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

テンポラリファイルのサイズを返します。

テンポラリファイルのサイズを返します。

require "tempfile"
tf = Tempfile.new("foo")
tf.print("bar,ugo")
p tf.size # => 7
tf.close
p tf.size # => 7

• Tempfile

Tempfile#unlink -> self (22.0)

• 2.2.0

• インスタンスメソッド

テンポラリファイルをクローズせずに、削除します。 UNIXライクなシステムでは、 作成したテンポラリファイルが他のプログラムに使用される機会をなくすために、 テンポラリファイルを作成しオープンした後、 すぐに削除するということがしばしばおこなわれます。

テンポラリファイルをクローズせずに、削除します。
UNIXライクなシステムでは、
作成したテンポラリファイルが他のプログラムに使用される機会をなくすために、
テンポラリファイルを作成しオープンした後、
すぐに削除するということがしばしばおこなわれます。


require "tempfile"
tf = Tempfile.new("foo")
tf.unlink
p tf.path # => nil
tf.print("foobar,hoge\n")
tf.rewind
p tf.gets("\n") # => "foobar,hoge\n"

• Tempfile

Thread#abort_on_exception -> bool (22.0)

• 2.2.0

• インスタンスメソッド

真の場合、そのスレッドが例外によって終了した時に、インタプリタ 全体を中断させます。false の場合、あるスレッドで起こった例 外は、Thread#join などで検出されない限りそのスレッ ドだけをなにも警告を出さずに終了させます。

真の場合、そのスレッドが例外によって終了した時に、インタプリタ
全体を中断させます。false の場合、あるスレッドで起こった例
外は、Thread#join などで検出されない限りそのスレッ
ドだけをなにも警告を出さずに終了させます。

デフォルトは偽です。c:Thread#exceptionを参照してください。

@param newstate 自身を実行中に例外発生した場合、インタプリタ全体を終了させるかどうかを true か false で指定します。

//emlist[例][ruby]{
thread = Thread.new { sleep 1 }
thread.abort_o...

• Thread

Thread#add_trace_func(pr) -> Proc (22.0)

• 2.2.0

• インスタンスメソッド

スレッドにトレース用ハンドラを追加します。

スレッドにトレース用ハンドラを追加します。

追加したハンドラを返します。

@param pr トレースハンドラ(Proc オブジェクト)

//emlist[例][ruby]{
th = Thread.new do
class Trace
end
43.to_s
end
th.add_trace_func lambda {|*arg| p arg }
th.join

# => ["line", "example.rb", 4, nil, #<Binding:0x00007f98e107d0d8>, nil]
# => ["c-call", "example.rb", 4, ...

• Proc
• Thread

Thread#alive? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スレッドが「生きている」時、true を返します。

スレッドが「生きている」時、true を返します。

例:
thr = Thread.new { }
thr.join # => #<Thread:0x401b3fb0 dead>
Thread.current.alive? # => true
thr.alive? # => false

Thread#status が真を返すなら、このメソッドも真です。

@see Thread#status, Thread#stop?

• Thread

絞り込み条件を変える

Thread#backtrace_locations(range) -> [Thread::Backtrace::Location] | nil (22.0)

• 2.2.0

• インスタンスメソッド

スレッドの現在のバックトレースを Thread::Backtrace::Location の配 列で返します。

スレッドの現在のバックトレースを Thread::Backtrace::Location の配
列で返します。

引数で指定した値が範囲外の場合、スレッドがすでに終了している場合は nil
を返します。

@param start 開始フレームの位置を数値で指定します。

@param length 取得するフレームの個数を指定します。

@param range 取得したいフレームの範囲を示す Range オブジェクトを指定します。

Kernel.#caller_locations と似ていますが、本メソッドは self に限定
した情報を返します。

//emlist[例][ruby]...

• Thread
• Thread::Backtrace::Location

Thread#backtrace_locations(start = 0, length = nil) -> [Thread::Backtrace::Location] | nil (22.0)

• 2.2.0

• インスタンスメソッド

スレッドの現在のバックトレースを Thread::Backtrace::Location の配 列で返します。

スレッドの現在のバックトレースを Thread::Backtrace::Location の配
列で返します。

引数で指定した値が範囲外の場合、スレッドがすでに終了している場合は nil
を返します。

@param start 開始フレームの位置を数値で指定します。

@param length 取得するフレームの個数を指定します。

@param range 取得したいフレームの範囲を示す Range オブジェクトを指定します。

Kernel.#caller_locations と似ていますが、本メソッドは self に限定
した情報を返します。

//emlist[例][ruby]...

• Thread
• Thread::Backtrace::Location

Thread#exit -> self (22.0)

• 2.2.0

• インスタンスメソッド

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

ただし、スレッドは終了処理中(aborting)にはなりますが、
直ちに終了するとは限りません。すでに終了している場合は何もしません。このメソッドにより
終了したスレッドの Thread#value の返り値は不定です。
自身がメインスレッドであるか最後のスレッドである場合は、プロセスを Kernel.#exit(0)
により終了します。

Kernel.#exit と違い例外 SystemExit を発生しません。

th1 = Thread.new do
begin
sleep 10
...

• SystemExit
• Thread

Thread#inspect -> String (22.0)

• 2.2.0

• インスタンスメソッド

自身を人間が読める形式に変換した文字列を返します。

自身を人間が読める形式に変換した文字列を返します。

//emlist[例][ruby]{
a = Thread.current
a.inspect # => "#<Thread:0x00007fdbaf07ddb0 run>"
b = Thread.new{}
b.inspect # => "#<Thread:0x00007fdbaf8f7d10@(irb):3 dead>"
//}

• Thread

Thread#kill -> self (22.0)

• 2.2.0

• インスタンスメソッド

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

ただし、スレッドは終了処理中(aborting)にはなりますが、
直ちに終了するとは限りません。すでに終了している場合は何もしません。このメソッドにより
終了したスレッドの Thread#value の返り値は不定です。
自身がメインスレッドであるか最後のスレッドである場合は、プロセスを Kernel.#exit(0)
により終了します。

Kernel.#exit と違い例外 SystemExit を発生しません。

th1 = Thread.new do
begin
sleep 10
...

• SystemExit
• Thread

絞り込み条件を変える

Thread#raise(error_type, message, traceback) -> () (22.0)

• 2.2.0

• インスタンスメソッド

自身が表すスレッドで強制的に例外を発生させます。

自身が表すスレッドで強制的に例外を発生させます。

@param error_type Kernel.#raise を参照してください。

@param message Kernel.#raise を参照してください。

@param traceback Kernel.#raise を参照してください。

Thread.new {
sleep 1
Thread.main.raise "foobar"
}

begin
sleep
rescue
p $!, $@
end

=> #<RuntimeError: foobar>
[...

• Thread

Thread#run -> self (22.0)

• 2.2.0

• インスタンスメソッド

停止状態(stop)のスレッドを再開させます。 Thread#wakeup と異なりすぐにスレッドの切り替え を行います。

停止状態(stop)のスレッドを再開させます。
Thread#wakeup と異なりすぐにスレッドの切り替え
を行います。

@raise ThreadError 死んでいるスレッドに対して実行すると発生します。

//emlist[例][ruby]{
a = Thread.new { puts "a"; Thread.stop; puts "c" }
sleep 0.1 while a.status!='sleep'
puts "Got here"
a.run
a.join
# => a
# => Got here
# => c
//}

@see Thread#wakeup, Threa...

• Thread

Thread#safe_level -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

self のセーフレベルを返します。カレントスレッドの safe_level は、$SAFE と同じです。

self のセーフレベルを返します。カレントスレッドの
safe_level は、$SAFE と同じです。

Ruby 2.6 から$SAFEがプロセスグローバルになったため、このメソッドは obsolete になりました。

セーフレベルについてはspec/safelevelを参照してください。

//emlist[例][ruby]{
thr = Thread.new { $SAFE = 1; sleep }
Thread.current.safe_level # => 0
thr.safe_level # => 1
//}

• Thread
• spec/safelevel

Thread#set_trace_func(pr) -> Proc | nil (22.0)

• 2.2.0

• インスタンスメソッド

スレッドにトレース用ハンドラを設定します。

スレッドにトレース用ハンドラを設定します。

nil を渡すとトレースを解除します。

設定したハンドラを返します。

//emlist[例][ruby]{
th = Thread.new do
class Trace
end
2.to_s
Thread.current.set_trace_func nil
3.to_s
end
th.set_trace_func lambda {|*arg| p arg }
th.join

# => ["line", "example.rb", 2, nil, #<Binding:0x00007fc8de87cb08>, nil]
#...

• Proc
• Thread

Thread#stop? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

スレッドが終了(dead)あるいは停止(stop)している時、true を返します。

スレッドが終了(dead)あるいは停止(stop)している時、true を返します。

//emlist[例][ruby]{
a = Thread.new { Thread.stop }
b = Thread.current
a.stop? # => true
b.stop? # => false
//}

@see Thread#alive?, Thread#status

• Thread

絞り込み条件を変える

Thread#terminate -> self (22.0)

• 2.2.0

• インスタンスメソッド

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

スレッドの実行を終了させます。終了時に ensure 節が実行されます。

ただし、スレッドは終了処理中(aborting)にはなりますが、
直ちに終了するとは限りません。すでに終了している場合は何もしません。このメソッドにより
終了したスレッドの Thread#value の返り値は不定です。
自身がメインスレッドであるか最後のスレッドである場合は、プロセスを Kernel.#exit(0)
により終了します。

Kernel.#exit と違い例外 SystemExit を発生しません。

th1 = Thread.new do
begin
sleep 10
...

• SystemExit
• Thread

Thread#thread_variable_set(key, value) (22.0)

• 2.2.0

• インスタンスメソッド

引数 key で指定した名前のスレッドローカル変数に引数 value をセットしま す。

引数 key で指定した名前のスレッドローカル変数に引数 value をセットしま
す。

[注意]: Thread#[] でセットしたローカル変数(Fiber ローカル変数)と
異なり、セットした変数は Fiber を切り替えても共通で使える事に注意してく
ださい。

//emlist[例][ruby]{
thr = Thread.new do
Thread.current.thread_variable_set(:cat, 'meow')
Thread.current.thread_variable_set("dog", 'woof')
end
thr.join ...

• Thread

Thread#wakeup -> self (22.0)

• 2.2.0

• インスタンスメソッド

停止状態(stop)のスレッドを実行可能状態(run)にします。

停止状態(stop)のスレッドを実行可能状態(run)にします。

@raise ThreadError 死んでいるスレッドに対して実行すると発生します。

//emlist[例][ruby]{
c = Thread.new { Thread.stop; puts "hey!" }
sleep 0.1 while c.status!='sleep'
c.wakeup
c.join
# => "hey!"
//}

@see Thread#run, Thread.stop

• Thread

Thread::Backtrace::Location#absolute_path -> String (22.0)

• 2.2.0

• インスタンスメソッド

self が表すフレームの絶対パスを返します。

self が表すフレームの絶対パスを返します。

//emlist[例][ruby]{
# foo.rb
class Foo
attr_accessor :locations
def initialize(skip)
@locations = caller_locations(skip)
end
end

Foo.new(0..2).locations.map do |call|
puts call.absolute_path
end

# => /path/to/foo.rb
# /path/to/foo.rb
# /path/to/foo.rb
//}

@see...

• Thread::Backtrace::Location

Thread::Queue#clear -> () (22.0)

• 2.2.0

• インスタンスメソッド

キューを空にします。返り値は不定です。

キューを空にします。返り値は不定です。

//emlist[例][ruby]{
require 'thread'
q = Queue.new

[:resource1, :resource2, :resource3, nil].each { |r| q.push(r) }

q.length # => 4
q.clear
q.length # => 0
//}

• Thread::Queue

絞り込み条件を変える

Thread::Queue#empty? -> bool (22.0)

• 2.2.0

• インスタンスメソッド

キューが空の時、真を返します。

キューが空の時、真を返します。

//emlist[例][ruby]{
require 'thread'
q = Queue.new
q.empty? # => true
q.push(:resource)
q.empty? # => false
//}

• Thread::Queue

Thread::Queue#length -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

キューの長さを返します。

キューの長さを返します。

//emlist[例][ruby]{
require 'thread'
q = Queue.new

[:resource1, :resource2, :resource3, nil].each { |r| q.push(r) }

q.length # => 4
//}

• Thread::Queue

Thread::Queue#size -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

キューの長さを返します。

キューの長さを返します。

//emlist[例][ruby]{
require 'thread'
q = Queue.new

[:resource1, :resource2, :resource3, nil].each { |r| q.push(r) }

q.length # => 4
//}

• Thread::Queue

Thread::SizedQueue#max -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

キューの最大サイズを返します。

キューの最大サイズを返します。

//emlist[例][ruby]{
q = SizedQueue.new(4)
q.max # => 4
//}

• Thread::SizedQueue

Thread::SizedQueue#max=(n) (22.0)

• 2.2.0

• インスタンスメソッド

キューの最大サイズを設定します。

キューの最大サイズを設定します。

@param n キューの最大サイズを指定します。

//emlist[例][ruby]{
require 'thread'
q = SizedQueue.new(4)
q.max # => 4
q.max = 5
q.max # => 5
//}

• Thread::SizedQueue

絞り込み条件を変える

TracePoint#binding -> Binding (22.0)

• 2.2.0

• インスタンスメソッド

発生したイベントによって生成された Binding オブジェクトを返します。

発生したイベントによって生成された Binding オブジェクトを返します。


//emlist[例][ruby]{
def foo(ret)
ret
end
trace = TracePoint.new(:call) do |tp|
p tp.binding.local_variables # => [:ret]
end
trace.enable
foo 1
//}

• Binding
• TracePoint

TracePoint#inspect -> String (22.0)

• 2.2.0

• インスタンスメソッド

self の状態を人間に読みやすい文字列にして返します。

self の状態を人間に読みやすい文字列にして返します。

//emlist[例][ruby]{
def foo(ret)
ret
end
trace = TracePoint.new(:call) do |tp|
p tp.inspect # "#<TracePoint:call `foo'@/path/to/test.rb:1>"
end
trace.enable
foo 1
//}

• TracePoint

TracePoint#lineno -> Integer (22.0)

• 2.2.0

• インスタンスメソッド

発生したイベントの行番号を返します。

発生したイベントの行番号を返します。

@raise RuntimeError イベントフックの外側で実行した場合に発生します。

//emlist[例][ruby]{
def foo(ret)
ret
end
trace = TracePoint.new(:call, :return) do |tp|
tp.lineno
end
trace.enable
foo 1
# => 1
# 3
//}

• TracePoint

TracePoint#path -> String (22.0)

• 2.2.0

• インスタンスメソッド

イベントが発生したファイルのパスを返します。

イベントが発生したファイルのパスを返します。

@raise RuntimeError イベントフックの外側で実行した場合に発生します。

//emlist[例][ruby]{
def foo(ret)
ret
end
trace = TracePoint.new(:call) do |tp|
p tp.path # => "/path/to/test.rb"
end
trace.enable
foo 1
//}

• TracePoint

TracePoint#raised_exception -> Exception (22.0)

• 2.2.0

• インスタンスメソッド

発生した例外を返します。

発生した例外を返します。

@raise RuntimeError :raise イベントのためのイベントフックの外側で実行し
た場合に発生します。

//emlist[例][ruby]{
trace = TracePoint.new(:raise) do |tp|
tp.raised_exception # => #<ZeroDivisionError: divided by 0>
end
trace.enable
begin
0/0
rescue
end
//}

• TracePoint

絞り込み条件を変える

TracePoint#return_value -> object (22.0)

• 2.2.0

• インスタンスメソッド

メソッドやブロックの戻り値を返します。

メソッドやブロックの戻り値を返します。

@raise RuntimeError :return、:c_return、:b_return イベントのためのイベ
ントフックの外側で実行した場合に発生します。

//emlist[例][ruby]{
def foo(ret)
ret
end
trace = TracePoint.new(:return) do |tp|
p tp.return_value # => 1
end
trace.enable
foo 1
//}

• TracePoint

UNIXServer#accept_nonblock -> UnixSocket (22.0)

• 2.2.0

• インスタンスメソッド

ソケットをノンブロッキングモードに設定した後、 accept(2) を呼び出します。

ソケットをノンブロッキングモードに設定した後、
accept(2) を呼び出します。

接続した
UNIXSocket のインスタンスを返します。

accept(2) がエラーになった場合、Socket#accept と同じ例外が
発生します。

Errno::EWOULDBLOCK, Errno::EAGAIN,
Errno::ECONNABORTED, Errno::EPROTO のいずれかの例外が
発生した場合は、その例外には IO::WaitReadable が extend
されます。それを利用してリトライ可能な例外を掴まえることができます。

require 'socket...

• Errno::EAGAIN
• Errno::ECONNABORTED
• Errno::EPROTO
• Errno::EWOULDBLOCK
• IO::WaitReadable
• UNIXServer
• UNIXSocket

WEBrick::BasicLog#<<(obj) -> () (22.0)

• 2.2.0

• インスタンスメソッド

指定された obj を to_s メソッドで文字列に変換してから、 ログレベル INFO でログに記録します。

指定された obj を to_s メソッドで文字列に変換してから、
ログレベル INFO でログに記録します。

@param obj 記録したいオブジェクトを指定します。文字列でない場合は to_s メソッドで文字列に変換します。

require 'webrick'
logger = WEBrick::BasicLog.new()
logger << 'hoge'

• WEBrick::BasicLog

WEBrick::BasicLog#fatal(msg) -> () (22.0)

• 2.2.0

• インスタンスメソッド

ログレベル FATAL で文字列 msg をログに記録します。

ログレベル FATAL で文字列 msg をログに記録します。

行頭に level を表す文字列が追加されます。
msg の終端が "\n" でない場合には "\n" を追加します。

@param msg 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

require 'webrick'
logger = WEBrick::BasicLog.new()
logger.fatal('out of money') #=> FATAL out of money (標準エラー出力に出力)

• WEBrick::BasicLog

WEBrick::CGI#config -> Hash (22.0)

• 2.2.0

• インスタンスメソッド

自身の設定を保持したハッシュを返します。

自身の設定を保持したハッシュを返します。

@see WEBrick::CGI.new

• WEBrick::CGI

絞り込み条件を変える

WEBrick::CGI#logger -> WEBrick::BasicLog (22.0)

• 2.2.0

• インスタンスメソッド

設定されているログオブジェクトを返します。

設定されているログオブジェクトを返します。

デフォルトでは WEBrick::BasicLog.new($stderr) です。

• WEBrick::BasicLog
• WEBrick::CGI

WEBrick::HTTPResponse#body=(val) (22.0)

• 2.2.0

• インスタンスメソッド

クライアントに返す内容(エンティティボディ)をセットします。

クライアントに返す内容(エンティティボディ)をセットします。

自身が chunked であっても body の値はチャンク形式ではありません。

@param val メッセージボディを文字列か IO オブジェクトで指定します。
自身が chunked であってもチャンク形式にする必要はありません。
適切にチャンク形式エンコーディングされます。

require 'webrick'
include WEBrick
res = HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.bod...

• IO
• WEBrick::HTTPResponse

WEBrick::HTTPResponse#chunked=(flag) (22.0)

• 2.2.0

• インスタンスメソッド

真に設定するとクライアントに返す内容(エンティティボディ)を chunk に分けるようになります。

真に設定するとクライアントに返す内容(エンティティボディ)を chunk に分けるようになります。

自身の WEBrick::HTTPResponse#request_http_version が 1.0 以下である場合、この値は無視されます。

@param flag true を指定した場合、レスポンスを chunk に分けてクライアントに返します。

require 'webrick'
include WEBrick
res = HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.body = 'hoge'
res....

• WEBrick::HTTPResponse

WEBrick::HTTPResponse#http_version -> WEBrick::HTTPVersion (22.0)

• 2.2.0

• インスタンスメソッド

レスポンスの HTTP のバージョンを表す WEBrick::HTTPVersion オブジェクトを返します。

レスポンスの HTTP のバージョンを表す WEBrick::HTTPVersion オブジェクトを返します。

require 'webrick'
res = WEBrick::HTTPResponse.new( { :HTTPVersion => "1.1" } )
p res.http_version.class #=> WEBrick::HTTPVersion
p res.http_version.to_s #=...

• WEBrick::HTTPResponse
• WEBrick::HTTPVersion

WEBrick::HTTPResponse#reason_phrase=(val) (22.0)

• 2.2.0

• インスタンスメソッド

HTTP のレスポンスの最初の行の reason phrase をセットします。 この値が nil の場合 reason phrase は status から生成されます。 デフォルトは nil です。

HTTP のレスポンスの最初の行の reason phrase をセットします。
この値が nil の場合 reason phrase は status から生成されます。
デフォルトは nil です。

@param val reason phrase を表す文字列を指定します。

require 'webrick'
res = WEBrick::HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.status = 404

p res.reason_phrase #=> "Not Found"

• WEBrick::HTTPResponse

絞り込み条件を変える

WEBrick::HTTPResponse#status=(status) (22.0)

• 2.2.0

• インスタンスメソッド

レスポンスのステータスコードを整数で指定します。 reason_phrase も適切なものに設定されます。

レスポンスのステータスコードを整数で指定します。
reason_phrase も適切なものに設定されます。

@param status ステータスコードを整数で指定します。

require 'webrick'
res = WEBrick::HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.status = 404

p res.reason_phrase #=> "Not Found"

• WEBrick::HTTPResponse

WEBrick::HTTPResponse#status_line -> String (22.0)

• 2.2.0

• インスタンスメソッド

HTTP のステータスラインを CR+LF 付き文字列で返します。

HTTP のステータスラインを CR+LF 付き文字列で返します。

require 'webrick'
res = WEBrick::HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.status = 404

p res.status_line #=> "HTTP/1.1 404 Not Found \r\n"

• WEBrick::HTTPResponse

WEBrick::HTTPResponse#to_s -> String (22.0)

• 2.2.0

• インスタンスメソッド

実際にクライアントに送られるデータを文字列として返します。

実際にクライアントに送られるデータを文字列として返します。

require 'webrick'
include WEBrick
res = HTTPResponse.new( { :HTTPVersion => "1.1" } )
res.body = 'hoge'
print res.to_s

#=> 出力結果
HTTP/1.1 200 OK
Connection: Keep-Alive
Date: Sat, 27 Oct 2007 08:58:49 GMT
Server:
Content-Length: 4

hoge

• WEBrick::HTTPResponse

WEBrick::HTTPServer#mount(dir, servlet, *options) -> () (22.0)

• 2.2.0

• インスタンスメソッド

サーバ上のディレクトリ dir にサーブレット servlet を対応させます。

サーバ上のディレクトリ dir にサーブレット servlet を対応させます。

@param dir ディレクトリをあらわす文字列を指定します。

@param servlet WEBrick::HTTPServlet::AbstractServlet のサブクラスのインスタンスを指定します。

@param options サーブレットのコンストラクタの引数を指定します。

require 'webrick'
include WEBrick
srv = HTTPServer.new( { :BindAddress => '127.0.0.1', :Port => 10080...

• WEBrick::HTTPServer
• WEBrick::HTTPServlet::AbstractServlet

WEBrick::HTTPServlet::AbstractServlet#do_DELETE(request, response) -> () (22.0)

• 2.2.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

絞り込み条件を変える