検索結果

Net::HTTP#head(path, header = nil) -> Net::HTTPResponse (54658.0)

• 2.7.0

• インスタンスメソッド

サーバ上の path にあるエンティティのヘッダのみを取得します。 Net::HTTPResponse のインスタンスを返します。

サーバ上の path にあるエンティティのヘッダのみを取得します。
Net::HTTPResponse のインスタンスを返します。

header が nil
でなければ、リクエストを送るときにその内容を HTTP ヘッダとして
送ります。 header は { 'Accept' = > '*/*', ... } という
形のハッシュでなければいけません。

@param path 取得するエンティティのパスを文字列で指定します。
@param header リクエストの HTTP ヘッダをハッシュで指定します。

1.1 互換モードの場合は、レスポンスに応じて例外が発生します。

//em...

• Net::HTTP
• Net::HTTPResponse

Kernel#create_header(header = "extconf.h") -> String (18619.0)

• 2.7.0

• インスタンスメソッド

Kernel#have_func, Kernel#have_header などの検査結果を元に、 ヘッダファイルを生成します。

Kernel#have_func, Kernel#have_header などの検査結果を元に、
ヘッダファイルを生成します。

このメソッドは extconf.rb の最後で呼び出すようにしてください。

@param header ヘッダファイルの名前を指定します。

@return ヘッダファイルの名前を返します。

例

# extconf.rb
require 'mkmf'
have_func('realpath')
have_header('sys/utime.h')
create_header
create_makefile('foo')

上の ext...

• Kernel

OptionParser#on_head(*arg, &block) -> self (18340.0)

• 2.7.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

puts opts.help

# => ...

• OptionParser

CSV#header_convert {|field, field_info| ... } (18337.0)

• 2.7.0

• インスタンスメソッド

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

このメソッドはヘッダ行を読み込む前に呼び出さなければなりません。

@param name 変換器の名前を指定します。

//emlist[例 name を指定][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true)
csv.header_convert(:symbol)
csv.first.headers # => [:header1, :header2]
//}

//emlist[例 ブロックを指定][...

• CSV

CSV#header_convert {|field| ... } (18337.0)

• 2.7.0

• インスタンスメソッド

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

このメソッドはヘッダ行を読み込む前に呼び出さなければなりません。

@param name 変換器の名前を指定します。

//emlist[例 name を指定][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true)
csv.header_convert(:symbol)
csv.first.headers # => [:header1, :header2]
//}

//emlist[例 ブロックを指定][...

• CSV

絞り込み条件を変える

CSV#header_convert(name) (18337.0)

• 2.7.0

• インスタンスメソッド

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

CSV#convert に似ていますが、ヘッダ行用のメソッドです。

このメソッドはヘッダ行を読み込む前に呼び出さなければなりません。

@param name 変換器の名前を指定します。

//emlist[例 name を指定][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true)
csv.header_convert(:symbol)
csv.first.headers # => [:header1, :header2]
//}

//emlist[例 ブロックを指定][...

• CSV

CSV#header_converters -> Array (18319.0)

• 2.7.0

• インスタンスメソッド

現在有効なヘッダ用変換器のリストを返します。

現在有効なヘッダ用変換器のリストを返します。

組込みの変換器は名前を返します。それ以外は、オブジェクトを返します。

//emlist[例][ruby]{
require "csv"

csv = CSV.new("HEADER1,HEADER2\nrow1_1,row1_2", headers: true, header_converters: CSV::HeaderConverters.keys)
csv.header_converters # => [:downcase, :symbol]
csv.read.to_a # => header2], ["row1_1",...

• CSV

CSV#header_row? -> bool (18319.0)

• 2.7.0

• インスタンスメソッド

次に読み込まれる行が、ヘッダである場合に真を返します。 そうでない場合は、偽を返します。

次に読み込まれる行が、ヘッダである場合に真を返します。
そうでない場合は、偽を返します。

//emlist[例][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true)
csv.header_row? # => true
csv.readline
csv.header_row? # => false
//}

• CSV

CSV#headers -> Array | true | nil (18319.0)

• 2.7.0

• インスタンスメソッド

nil を返した場合は、ヘッダは使用されません。 真を返した場合は、ヘッダを使用するが、まだ読み込まれていません。 配列を返した場合は、ヘッダは既に読み込まれています。

nil を返した場合は、ヘッダは使用されません。
真を返した場合は、ヘッダを使用するが、まだ読み込まれていません。
配列を返した場合は、ヘッダは既に読み込まれています。

//emlist[例][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2")
csv.headers # => nil
csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true)
csv.headers # => true
csv.read
csv.headers # =>...

• CSV

CSV#return_headers? -> bool (18319.0)

• 2.7.0

• インスタンスメソッド

ヘッダを返す場合は、真を返します。 そうでない場合は、偽を返します。

ヘッダを返す場合は、真を返します。
そうでない場合は、偽を返します。

//emlist[例][ruby]{
require "csv"

csv = CSV.new("header1,header2\nrow1_1,row1_2", headers: true, return_headers: false)
csv.return_headers? # => false
csv.shift # => #<CSV::Row "header1":"row1_1" "header2":"row1_2">

csv = CSV.new("header1,header2\nrow1_1,row1_2"...

• CSV

絞り込み条件を変える

CSV#write_headers? -> bool (18319.0)

• 2.7.0

• インスタンスメソッド

ヘッダを出力先に書き込む場合は真を返します。 そうでない場合は偽を返します。

ヘッダを出力先に書き込む場合は真を返します。
そうでない場合は偽を返します。

//emlist[例][ruby]{
require "csv"

csv = CSV.new("date1,date2\n2018-07-09,2018-07-10")
csv.write_headers? # => nil

header = ["header1", "header2"]
row = ["row1_1", "row1_2"]
result = CSV.generate(headers: header, write_headers: false) do |csv|
csv.write_hea...

• CSV

CSV::FieldInfo#header -> String | nil (18319.0)

• 2.7.0

• インスタンスメソッド

利用可能な場合はヘッダを表す文字列を返します。

利用可能な場合はヘッダを表す文字列を返します。

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

csv = CSV.new("date1,date2\n2018-07-09,2018-07-10", headers: true)
csv.convert do |field,field_info|
p field_info.header
Date.parse(field)
end
p csv.first

# => "date1"
# => "date2"
# => #<CSV::Row "date1":#<Date: 2018-07-09 ((2458309j,...

• CSV::FieldInfo

CSV::Row#header?(name) -> bool (18319.0)

• 2.7.0

• インスタンスメソッド

自身のヘッダに与えられた値が含まれている場合は真を返します。 そうでない場合は偽を返します。

自身のヘッダに与えられた値が含まれている場合は真を返します。
そうでない場合は偽を返します。

@param name この行のヘッダに含まれているかどうか調べたい値を指定します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], [1, 2])
row.header?("header1") # => true
row.header?("header3") # => false
//}

• CSV::Row

CSV::Row#header_row? -> bool (18319.0)

• 2.7.0

• インスタンスメソッド

ヘッダ行であれば真を返します。そうでなければ偽を返します。

ヘッダ行であれば真を返します。そうでなければ偽を返します。

//emlist[例][ruby]{
require "csv"

header_row = CSV::Row.new(["header1", "header2"], [], true)
row = CSV::Row.new(["header1", "header2"], [1, 2])
header_row.header_row? # => true
row.header_row? # => false
//}

• CSV::Row

CSV::Row#headers -> Array (18319.0)

• 2.7.0

• インスタンスメソッド

この行のヘッダのリストを返します。

この行のヘッダのリストを返します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], [1, 2])
row.headers # => ["header1", "header2"]
//}

• CSV::Row

絞り込み条件を変える

CSV::Table#headers -> Array (18319.0)

• 2.7.0

• インスタンスメソッド

自身のヘッダ行を返します。

自身のヘッダ行を返します。

テーブルが空である場合は空の配列を返します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])
table = CSV::Table.new([row])
table.headers # => ["header1", "header2"]
//}

• CSV::Table

Net::HTTPHeader#each_header {|name, val| .... } -> () (18319.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダ名とその値をそれぞれ ブロックに渡して呼びだします。

保持しているヘッダ名とその値をそれぞれ
ブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。
val は ", " で連結した文字列がブロックに渡されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_header { |key,value| puts "#{key} = #{value}" }

# => accept-encoding...

• Net::HTTPHeader

URI::MailTo#headers -> [[String]] (18319.0)

• 2.7.0

• インスタンスメソッド

自身のヘッダーを文字列の配列の配列として設定します。

自身のヘッダーを文字列の配列の配列として設定します。

例:
require 'uri'
m = URI.parse("mailto:ruby-list@ruby-lang.org?subject=subscribe&cc=myaddr")
p m.headers #=> [["subject", "subscribe"], ["cc", "myaddr"]]

• URI::MailTo

URI::MailTo#headers=(s) (18319.0)

• 2.7.0

• インスタンスメソッド

自身のヘッダーを文字列で設定します。

自身のヘッダーを文字列で設定します。

@param s ヘッダーを表す文字列を指定します。

@raise URI::InvalidComponentError 不正な引数 s に対して発生します。

例:
require 'uri'
m = URI.parse("mailto:nospam@example.com")
m.headers = URI.escape("subject=hello hello")

• URI::MailTo

WEBrick::HTTPServlet::AbstractServlet#do_HEAD(request, response) -> () (9322.0)

• 2.7.0

• インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

Net::HTTPHeader#fetch(key) -> String (9073.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

該当するキーが登録されてい
ない時には、引数 default が与えられていればその値を、ブロッ
クが与えられていればそのブロックを評価した値を返します。

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て ", " で連結した文字列を返します。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。
@param default 該...

• Net::HTTPHeader

Net::HTTPHeader#fetch(key) {|hash| .... } -> String (9073.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

該当するキーが登録されてい
ない時には、引数 default が与えられていればその値を、ブロッ
クが与えられていればそのブロックを評価した値を返します。

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て ", " で連結した文字列を返します。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。
@param default 該...

• Net::HTTPHeader

Net::HTTPHeader#fetch(key, default) -> String (9073.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

該当するキーが登録されてい
ない時には、引数 default が与えられていればその値を、ブロッ
クが与えられていればそのブロックを評価した値を返します。

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て ", " で連結した文字列を返します。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。
@param default 該...

• Net::HTTPHeader

Net::HTTPHeader#form_data=(params) (9037.0)

• 2.7.0

• インスタンスメソッド

HTMLのフォームのデータ params から ヘッダフィールドとボディを設定します。

HTMLのフォームのデータ params から
ヘッダフィールドとボディを設定します。

ヘッダフィールド Content-Type: には
'application/x-www-form-urlencoded' が設定されます。

@param params HTML のフォームデータの Hash を与えます。
@param sep データのセパレータを文字列で与えます。

//emlist[例 form_data][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Ne...

• Hash
• Net::HTTPHeader

Net::HTTPHeader#range -> Range|nil (9037.0)

• 2.7.0

• インスタンスメソッド

Range: ヘッダの示す範囲を Range オブジェクトで返します。

Range: ヘッダの示す範囲を Range オブジェクトで返します。

ヘッダにない場合は nil を返します。

@raise Net::HTTPHeaderSyntaxError Range:ヘッダの中身が規格通り
でない場合に発生します。

//emlist[例 正常な値][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
r...

• Net::HTTPHeader
• Range

絞り込み条件を変える

Net::HTTPHeader#set_form_data(params, sep = &#39;&&#39;) -> () (9037.0)

• 2.7.0

• インスタンスメソッド

HTMLのフォームのデータ params から ヘッダフィールドとボディを設定します。

HTMLのフォームのデータ params から
ヘッダフィールドとボディを設定します。

ヘッダフィールド Content-Type: には
'application/x-www-form-urlencoded' が設定されます。

@param params HTML のフォームデータの Hash を与えます。
@param sep データのセパレータを文字列で与えます。

//emlist[例 form_data][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Ne...

• Hash
• Net::HTTPHeader

CSV::Row#include?(name) -> bool (9019.0)

• 2.7.0

• インスタンスメソッド

自身のヘッダに与えられた値が含まれている場合は真を返します。 そうでない場合は偽を返します。

自身のヘッダに与えられた値が含まれている場合は真を返します。
そうでない場合は偽を返します。

@param name この行のヘッダに含まれているかどうか調べたい値を指定します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], [1, 2])
row.header?("header1") # => true
row.header?("header3") # => false
//}

• CSV::Row

Net::HTTPHeader#[](key) -> String|nil (9019.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドを返します。

key ヘッダフィールドを返します。

たとえばキー 'content-length' に対しては '2048'
のような文字列が得られます。キーが存在しなければ nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req['user-agent'] # => Ruby
//}

一種類のヘッダフィールドが一つのヘッダの中に複数存在する
場合にはそれを全て...

• Net::HTTPHeader

Net::HTTPHeader#[]=(key, val) (9019.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドに文字列 val をセットします。

key ヘッダフィールドに文字列 val をセットします。

key に元々設定されていた値は破棄されます。
key は大文字小文字を区別しません。
val に nil を与えるとそのフィールドを削除します。

@param key ヘッダフィール名を文字列で与えます。
@param val keyで指定したフィールドにセットする文字列を与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.re...

• Net::HTTPHeader

Net::HTTPHeader#basic_auth(account, password) -> [String] (9019.0)

• 2.7.0

• インスタンスメソッド

Authorization: ヘッダを BASIC 認証用にセットします。

Authorization: ヘッダを BASIC 認証用にセットします。

@param account アカウント名を文字列で与えます。
@param password パスワードを文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.basic_auth("user", "pass") # => ["Basic dXNlcjpwYXNz"]
//}...

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#chunked? -> bool (9019.0)

• 2.7.0

• インスタンスメソッド

Transfer-Encoding: ヘッダフィールドが "chunked" である 場合に真を返します。

Transfer-Encoding: ヘッダフィールドが "chunked" である
場合に真を返します。

Transfer-Encoding: ヘッダフィールドが存在しなかったり、
"chunked" 以外である場合には偽を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.chunked? # => false
req["Transfer-Encodin...

• Net::HTTPHeader

Net::HTTPHeader#content_length -> Integer|nil (9019.0)

• 2.7.0

• インスタンスメソッド

Content-Length: ヘッダフィールドの表している値を整数で返します。

Content-Length: ヘッダフィールドの表している値を整数で返します。

ヘッダが設定されていない場合には nil を返します。

@raise Net::HTTPHeaderSyntaxError フィールドの値が不正である場合に
発生します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
re...

• Net::HTTPHeader

Net::HTTPHeader#content_length=(len) (9019.0)

• 2.7.0

• インスタンスメソッド

Content-Length: ヘッダフィールドに値を設定します。

Content-Length: ヘッダフィールドに値を設定します。

len に nil を与えると Content-Length: ヘッダフィールドを
削除します。

@param len 設定する値を整数で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_length # => nil
req.content_length = ...

• Net::HTTPHeader

Net::HTTPHeader#content_range -> Range|nil (9019.0)

• 2.7.0

• インスタンスメソッド

Content-Range: ヘッダフィールドの値を Range で返します。 Range の表わす長さは Net::HTTPHeader#range_length で得られます。

Content-Range: ヘッダフィールドの値を Range で返します。
Range の表わす長さは Net::HTTPHeader#range_length で得られます。

ヘッダが設定されていない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_range # => nil
req['Content...

• Net::HTTPHeader

Net::HTTPHeader#content_type -> String|nil (9019.0)

• 2.7.0

• インスタンスメソッド

"text/html" のような Content-Type を表す 文字列を返します。

"text/html" のような Content-Type を表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/comments.cgi?post=comment')
req = Net::HTTP::Post.new(uri.request_uri)
req.content_type # => nil
req.content_type = 'multipart/for...

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#content_type=(type) (9019.0)

• 2.7.0

• インスタンスメソッド

type と params から Content-Type: ヘッダフィールドの 値を設定します。

type と params から Content-Type: ヘッダフィールドの
値を設定します。

@param type メディアタイプを文字列で指定します。
@param params パラメータ属性をハッシュで指定します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_type # => ni...

• Net::HTTPHeader

Net::HTTPHeader#delete(key) -> [String] | nil (9019.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドを削除します。

key ヘッダフィールドを削除します。

@param key 削除するフィールド名
@return 取り除かれたフィールドの値を返します。
key ヘッダフィールドが存在しなかった場合には
nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_length = 10
req.content_length...

• Net::HTTPHeader

Net::HTTPHeader#each {|name, val| .... } -> () (9019.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダ名とその値をそれぞれ ブロックに渡して呼びだします。

保持しているヘッダ名とその値をそれぞれ
ブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。
val は ", " で連結した文字列がブロックに渡されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_header { |key,value| puts "#{key} = #{value}" }

# => accept-encoding...

• Net::HTTPHeader

Net::HTTPHeader#each_capitalized_name {|name| .... } -> () (9019.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダ名を正規化 ('x-my-header' -> 'X-My-Header') して、ブロックに渡します。

保持しているヘッダ名を正規化
('x-my-header' -> 'X-My-Header')
して、ブロックに渡します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_capitalized_name { |key| puts key }

# => Accept-Encoding
# => Accept
# => User-Agent
//}

• Net::HTTPHeader

Net::HTTPHeader#each_key {|name| ... } -> () (9019.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダ名をブロックに渡して呼びだします。

保持しているヘッダ名をブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_name { |name| puts name }

# => accept-encoding
# => accept
# => user-agent
//}

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#each_name {|name| ... } -> () (9019.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダ名をブロックに渡して呼びだします。

保持しているヘッダ名をブロックに渡して呼びだします。

ヘッダ名は小文字で統一されます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_name { |name| puts name }

# => accept-encoding
# => accept
# => user-agent
//}

• Net::HTTPHeader

Net::HTTPHeader#each_value {|value| .... } -> () (9019.0)

• 2.7.0

• インスタンスメソッド

保持しているヘッダの値をブロックに渡し、呼びだします。

保持しているヘッダの値をブロックに渡し、呼びだします。

渡される文字列は ", " で連結したものです。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.each_value { |value| puts value }

# => gzip;q=1.0,deflate;q=0.6,identity;q=0.3
# => */*
# => Ruby
//}

• Net::HTTPHeader

Net::HTTPHeader#get_fields(key) -> [String] (9019.0)

• 2.7.0

• インスタンスメソッド

key ヘッダフィールドの値 (文字列) を配列で返します。

key ヘッダフィールドの値 (文字列) を配列で返します。

たとえばキー 'content-length' に対しては ['2048'] のような
文字列が得られます。一種類のヘッダフィールドが一つのヘッダの中
に複数存在することがありえます。
key は大文字小文字を区別しません。

@param key ヘッダフィール名を文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(ur...

• Net::HTTPHeader

Net::HTTPHeader#key?(key) -> bool (9019.0)

• 2.7.0

• インスタンスメソッド

key というヘッダフィールドがあれば真を返します。 key は大文字小文字を区別しません。

key というヘッダフィールドがあれば真を返します。
key は大文字小文字を区別しません。

@param key 探すヘッダフィールド名を文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.key?('content-type') # => true
res.key?('nonexist-header') # => false
//}

• Net::HTTPHeader

Net::HTTPHeader#main_type -> String|nil (9019.0)

• 2.7.0

• インスタンスメソッド

"text/html" における "text" のようなタイプを表す 文字列を返します。

"text/html" における "text" のようなタイプを表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.main_type # => "text"
//}

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#method -> String (9019.0)

• 2.7.0

• インスタンスメソッド

リクエストの HTTP メソッドを文字列で返します。

リクエストの HTTP メソッドを文字列で返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.method # => "GET"
//}

• Net::HTTPHeader

Net::HTTPHeader#proxy_basic_auth(account, password) -> [String] (9019.0)

• 2.7.0

• インスタンスメソッド

Proxy 認証のために Proxy-Authorization: ヘッダをセットします。

Proxy 認証のために Proxy-Authorization: ヘッダをセットします。

@param account アカウント名を文字列で与えます。
@param password パスワードを文字列で与えます。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.proxy_basic_auth("account", "password") # => ["Ba...

• Net::HTTPHeader

Net::HTTPHeader#range_length -> Integer|nil (9019.0)

• 2.7.0

• インスタンスメソッド

Content-Range: ヘッダフィールドの表している長さを整数で返します。

Content-Range: ヘッダフィールドの表している長さを整数で返します。

ヘッダが設定されていない場合には nil を返します。

@raise Net::HTTPHeaderSyntaxError Content-Range: ヘッダフィールド
の値が不正である場合に
発生します。


//emlist[例][ruby]{
require 'net/http'

uri = UR...

• Net::HTTPHeader

Net::HTTPHeader#set_content_type(type, params = {}) (9019.0)

• 2.7.0

• インスタンスメソッド

type と params から Content-Type: ヘッダフィールドの 値を設定します。

type と params から Content-Type: ヘッダフィールドの
値を設定します。

@param type メディアタイプを文字列で指定します。
@param params パラメータ属性をハッシュで指定します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.content_type # => ni...

• Net::HTTPHeader

Net::HTTPHeader#sub_type -> String|nil (9019.0)

• 2.7.0

• インスタンスメソッド

"text/html" における "html" のようなサブタイプを表す 文字列を返します。

"text/html" における "html" のようなサブタイプを表す
文字列を返します。

Content-Type: ヘッダフィールドが存在しない場合には nil を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.sub_type # => "html"
//}

• Net::HTTPHeader

絞り込み条件を変える

Net::HTTPHeader#type_params -> Hash (9019.0)

• 2.7.0

• インスタンスメソッド

Content-Type のパラメータを {"charset" => "iso-2022-jp"} という形の Hash で返します。

Content-Type のパラメータを {"charset" => "iso-2022-jp"}
という形の Hash で返します。

Content-Type: ヘッダフィールドが存在しない場合には
空のハッシュを返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
res = Net::HTTP.get_response(uri)
res.type_params # => {"charset"=>"UTF-8"}
//}

• Hash
• Net::HTTPHeader

CSV::Row.new(headers, fields, header_row = false) -> CSV::Row (637.0)

• 2.7.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

一方の配列が他方の配列よりも短い場合、不足しているところは nil になります。

@param headers ヘッダの配列を指定します。

@param fields フィールドの配列を指定します。

@param header_row ヘッダ行である場合は真を指定します。そうでない場合は偽を指定します。
デフォルトは偽です。

//emlist[例 header_row = true のケース][ruby]{
require "csv"

header = CSV::Row.new(["header1", "header2"]...

• CSV::Row

CSV::Row#[]=(header_or_index, value) (355.0)

• 2.7.0

• インスタンスメソッド

ヘッダの名前かインデックスでフィールドを探し、値をセットします。

ヘッダの名前かインデックスでフィールドを探し、値をセットします。

末尾より後ろのインデックスを指定すると、ヘッダの名前は nil になります。
存在しないヘッダを指定すると、新しい要素を末尾に追加します。

@param header_or_index ヘッダの名前かインデックスを指定します。

@param value 値を指定します。

//emlist[例 ヘッダの名前で指定][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])

row["header1"] ...

• CSV::Row

CSV::Row#delete(header_or_index, minimum_index = 0) -> [object, object] | nil (355.0)

• 2.7.0

• インスタンスメソッド

ヘッダの名前かインデックスで行からフィールドを削除するために使用します。

ヘッダの名前かインデックスで行からフィールドを削除するために使用します。

@param header_or_index ヘッダの名前かインデックスを指定します。

@param minimum_index このインデックスより後で、ヘッダの名前を探します。
重複しているヘッダがある場合に便利です。

@return 削除したヘッダとフィールドの組を返します。削除対象が見つからなかった場合は nil を返します。

//emlist[例 ヘッダの名前で指定][ruby]{
require "csv"

row = CSV::Row.new(["hea...

• CSV::Row

CSV::Table#values_at(indices_or_headers) -> Array (337.0)

• 2.7.0

• インスタンスメソッド

デフォルトのミックスモードでは、インデックスのリストを与えると行単位の 参照を行い、行の配列を返します。他の方法は列単位の参照と見なします。行 単位の参照では、返り値は行ごとの配列を要素に持つ配列です。

デフォルトのミックスモードでは、インデックスのリストを与えると行単位の
参照を行い、行の配列を返します。他の方法は列単位の参照と見なします。行
単位の参照では、返り値は行ごとの配列を要素に持つ配列です。

探索方法を変更したい場合は CSV::Table#by_col!,
CSV::Table#by_row! を使用してください。

アクセスモードを混在させることはできません。

//emlist[例 ロウモード][ruby]{
require "csv"

row1 = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])
r...

• CSV::Table

絞り込み条件を変える

CSV::Row#[](header_or_index, minimum_index = 0) -> object | nil (319.0)

• 2.7.0

• インスタンスメソッド

ヘッダの名前かインデックスで値を取得します。フィールドが見つからなかった場合は nil を返します。

ヘッダの名前かインデックスで値を取得します。フィールドが見つからなかった場合は nil を返します。

@param header_or_index ヘッダの名前かインデックスを指定します。

@param minimum_index このインデックスより後で、ヘッダの名前を探します。
重複しているヘッダがある場合に便利です。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])

row.field("h...

• CSV::Row

CSV::Row#delete_if {|header, field| ... } -> self (319.0)

• 2.7.0

• インスタンスメソッド

与えられたブロックにヘッダとフィールドのペアを渡して評価します。 評価した結果が真である場合に、その組を自身から削除します。

与えられたブロックにヘッダとフィールドのペアを渡して評価します。
評価した結果が真である場合に、その組を自身から削除します。

@return メソッドチェーンのために自身を返します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2", "header3", "header4"], ["valid1", "valid2", "invalid", "valid4"])

row # => #<CSV::Row "header1":"valid1" "header2":"valid2" "hea...

• CSV::Row

CSV::Row#each {|header, field| ... } -> self (319.0)

• 2.7.0

• インスタンスメソッド

与えられたブロックにヘッダとフィールドの組を渡して評価します。

与えられたブロックにヘッダとフィールドの組を渡して評価します。

@return メソッドチェーンのために自身を返します。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2", "header3", "header4"], [1, 2, 3, 4])
row.each { |header, field| puts "#{header} - #{field}" }

# => header1 - 1
# => header2 - 2
# => header3 - 3
# => header4 -...

• CSV::Row

CSV::Row#field(header_or_index, minimum_index = 0) -> object | nil (319.0)

• 2.7.0

• インスタンスメソッド

ヘッダの名前かインデックスで値を取得します。フィールドが見つからなかった場合は nil を返します。

ヘッダの名前かインデックスで値を取得します。フィールドが見つからなかった場合は nil を返します。

@param header_or_index ヘッダの名前かインデックスを指定します。

@param minimum_index このインデックスより後で、ヘッダの名前を探します。
重複しているヘッダがある場合に便利です。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])

row.field("h...

• CSV::Row

CSV::Row#fields(*headers_and_or_indices) -> Array (319.0)

• 2.7.0

• インスタンスメソッド

与えられた引数に対応する値の配列を返します。

与えられた引数に対応する値の配列を返します。

要素の探索に CSV::Row.field を使用しています。

@param headers_and_or_indices ヘッダの名前かインデックスか Range
のインスタンスか第 1 要素がヘッダの名前で
第 2 要素がオフセットになっている 2 要素
の配列をいくつでも指定します。混在するこ
とがで...

• CSV::Row
• Range

絞り込み条件を変える

CSV::Row#index(header, minimum_index = 0) -> Integer (319.0)

• 2.7.0

• インスタンスメソッド

与えられたヘッダの名前に対応するインデックスを返します。

与えられたヘッダの名前に対応するインデックスを返します。

@param header ヘッダの名前を指定します。

@param minimum_index このインデックスより後で、ヘッダの名前を探します。
重複しているヘッダがある場合に便利です。

//emlist[例][ruby]{
require "csv"

row = CSV::Row.new(["header1", "header2", "header1"], [1, 2, 3])
row.index("header1") # => 0
row.index("header1",...

• CSV::Row

CSV::Row#values_at(*headers_and_or_indices) -> Array (319.0)

• 2.7.0

• インスタンスメソッド

与えられた引数に対応する値の配列を返します。

与えられた引数に対応する値の配列を返します。

要素の探索に CSV::Row.field を使用しています。

@param headers_and_or_indices ヘッダの名前かインデックスか Range
のインスタンスか第 1 要素がヘッダの名前で
第 2 要素がオフセットになっている 2 要素
の配列をいくつでも指定します。混在するこ
とがで...

• CSV::Row
• Range

CSV::Table#[](header) -> [String] | [nil] (319.0)

• 2.7.0

• インスタンスメソッド

ミックスモードでは、このメソッドは引数に行番号を指定すれば行単位で動作 し、ヘッダの名前を指定すれば列単位で動作します。

ミックスモードでは、このメソッドは引数に行番号を指定すれば行単位で動作
し、ヘッダの名前を指定すれば列単位で動作します。

このメソッドを呼び出す前に CSV::Table#by_col! を呼び出すとカラム
モードになります。また CSV::Table#by_row! を呼び出すとロウモード
になります。

@param index ミックスモード・ロウモードでは、取得したい行の行番号を整数で指定します。
カラムモードでは、取得したい列の列番号を整数で指定します。
@param range 取得したい範囲を整数の範囲で指定します。
@param header 取得...

• CSV::Table

CSV::Table#[]=(index_or_header, value) (319.0)

• 2.7.0

• インスタンスメソッド

ミックスモードでは、このメソッドは引数に行番号を指定すれば行単位で動作 し、ヘッダの名前を指定すれば列単位で動作します。

ミックスモードでは、このメソッドは引数に行番号を指定すれば行単位で動作
し、ヘッダの名前を指定すれば列単位で動作します。

このメソッドを呼び出す前に CSV::Table#by_col! を呼び出すとカラム
モードになります。また CSV::Table#by_row! を呼び出すとロウモード
になります。

行には配列か CSV::Row のインスタンスを指定します。

列に値を一つだけ指定した場合は、全ての行にその値をコピーします。配列を
指定した場合は、上から順に値を割り当てます。余分な値は無視します。また、
値が不足している場合は nil を割り当てます。

既存の行または列のデータ...

• CSV::Row
• CSV::Table

CSV::Table#delete(index_or_header) -> object (319.0)

• 2.7.0

• インスタンスメソッド

指定された行か列を削除して返します。

指定された行か列を削除して返します。

デフォルトのミックスモードではインデックスによるアクセスは行単位での参
照であると見なします。しかし、他の方法ではヘッダによる列単位での参照で
あると見なします。

探索方法を変更したい場合は CSV::Table#by_col!,
CSV::Table#by_row! を使用してください。

//emlist[例][ruby]{
require "csv"

row1 = CSV::Row.new(["header1", "header2"], ["row1_1", "row1_2"])
row2 = CSV::Row.new(["header1",...

• CSV::Table

絞り込み条件を変える

Kernel#check_sizeof(type, headers = nil) -> Integer | nil (319.0)

• 2.7.0

• インスタンスメソッド

与えられた型のサイズを返します。

与えられた型のサイズを返します。

型 type がシステムに存在する場合は、グローバル変数 $defs に
"-DSIZEOF_type=X" を追加し、型のサイズを返します。型 type がシステムに
存在しない場合は、nil を返します。

例えば、

require 'mkmf'
check_sizeof('mystruct') # => 12

である場合、SIZEOF_MYSTRUCT=12 というプリプロセッサマクロをコンパイラに渡します。

@param type 検査したい型を指定します。

@param headers 追加のヘッダファイルを指定します。

• Kernel

Kernel#check_sizeof(type, headers = nil) { ... } -> Integer | nil (319.0)

• 2.7.0

• インスタンスメソッド

与えられた型のサイズを返します。

与えられた型のサイズを返します。

型 type がシステムに存在する場合は、グローバル変数 $defs に
"-DSIZEOF_type=X" を追加し、型のサイズを返します。型 type がシステムに
存在しない場合は、nil を返します。

例えば、

require 'mkmf'
check_sizeof('mystruct') # => 12

である場合、SIZEOF_MYSTRUCT=12 というプリプロセッサマクロをコンパイラに渡します。

@param type 検査したい型を指定します。

@param headers 追加のヘッダファイルを指定します。

• Kernel

Kernel#have_struct_member(type, member, headers = nil) -> bool (319.0)

• 2.7.0

• インスタンスメソッド

member というメンバを持つ構造体 type がシステムに存在するかどうか検査します。

member というメンバを持つ構造体 type がシステムに存在するかどうか検査します。

member というメンバを持つ構造体 type がシステムに存在する場合は、
グローバル変数 $defs に "-DHAVE_type_member" を追加し、真を返します。
member というメンバを持つ構造体 type が存在しない場合は、偽を返します。

例えば

require 'mkmf'
have_struct_member('struct foo', 'bar') # => true

である場合、HAVE_STRUCT_FOO_BAR というプリプロセッサマクロをコンパ...

• Kernel

Kernel#have_struct_member(type, member, headers = nil) { ... } -> bool (319.0)

• 2.7.0

• インスタンスメソッド

member というメンバを持つ構造体 type がシステムに存在するかどうか検査します。

member というメンバを持つ構造体 type がシステムに存在するかどうか検査します。

member というメンバを持つ構造体 type がシステムに存在する場合は、
グローバル変数 $defs に "-DHAVE_type_member" を追加し、真を返します。
member というメンバを持つ構造体 type が存在しない場合は、偽を返します。

例えば

require 'mkmf'
have_struct_member('struct foo', 'bar') # => true

である場合、HAVE_STRUCT_FOO_BAR というプリプロセッサマクロをコンパ...

• Kernel

Kernel#have_type(type, headers = nil, opt = "") -> bool (319.0)

• 2.7.0

• インスタンスメソッド

静的な型 type がシステムに存在するかどうか検査します。

静的な型 type がシステムに存在するかどうか検査します。

型 type がシステムに存在する場合は、グローバル変数 $defs に
"-DHAVE_type" を追加し、真を返します。型 type がシステムに存在しない場
合は、偽を返します。

例えば、

require 'mkmf'
have_type('foo') # => true

である場合、HAVE_TYPE_FOO をというプリプロセッサマクロをコンパイラに渡します。

@param type 検査したい型の名前を指定します。

@param headers 追加のヘッダを指定します。

@param opt ...

• Kernel

絞り込み条件を変える

Kernel#have_type(type, headers = nil, opt = "") { ... } -> bool (319.0)

• 2.7.0

• インスタンスメソッド

静的な型 type がシステムに存在するかどうか検査します。

静的な型 type がシステムに存在するかどうか検査します。

型 type がシステムに存在する場合は、グローバル変数 $defs に
"-DHAVE_type" を追加し、真を返します。型 type がシステムに存在しない場
合は、偽を返します。

例えば、

require 'mkmf'
have_type('foo') # => true

である場合、HAVE_TYPE_FOO をというプリプロセッサマクロをコンパイラに渡します。

@param type 検査したい型の名前を指定します。

@param headers 追加のヘッダを指定します。

@param opt ...

• Kernel

Kernel#have_var(var, headers = nil) -> bool (319.0)

• 2.7.0

• インスタンスメソッド

変数 var がシステムに存在するかどうか検査します。

変数 var がシステムに存在するかどうか検査します。

変数 var がシステムに存在する場合は、グローバル変数 $defs に
"-DHAVE_var" を追加し、真を返します。変数 var がシステムに存在しない場
合は、偽を返します。

例えば、

require 'mkmf'
have_var('foo') # => true

である場合、HAVE_FOO というプリプロセッサマクロをコンパイラに渡します。

@param var 検査したい変数名を指定します。

@param headers 追加のヘッダを指定します。

• Kernel

Kernel#have_var(var, headers = nil) { ... } -> bool (319.0)

• 2.7.0

• インスタンスメソッド

変数 var がシステムに存在するかどうか検査します。

変数 var がシステムに存在するかどうか検査します。

変数 var がシステムに存在する場合は、グローバル変数 $defs に
"-DHAVE_var" を追加し、真を返します。変数 var がシステムに存在しない場
合は、偽を返します。

例えば、

require 'mkmf'
have_var('foo') # => true

である場合、HAVE_FOO というプリプロセッサマクロをコンパイラに渡します。

@param var 検査したい変数名を指定します。

@param headers 追加のヘッダを指定します。

• Kernel

OptionParser#banner=(heading) (319.0)

• 2.7.0

• インスタンスメソッド

サマリの最初に表示される文字列を指定します。

サマリの最初に表示される文字列を指定します。

@param heading サマリの最初に表示される文字列を指定します。

//emlist[例][ruby]{
require "optparse"

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]" # => "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
option...

• OptionParser

WEBrick::HTTPUtils::FormData#[](header) -> String | nil (319.0)

• 2.7.0

• インスタンスメソッド

自身が multipart/form-data なデータの場合に、header で指定された ヘッダの値を文字列で返します。無ければ nil を返します。

自身が multipart/form-data なデータの場合に、header で指定された
ヘッダの値を文字列で返します。無ければ nil を返します。

@param header ヘッダ名を文字列で指定します。大文字と小文字を区別しません。

例:

require "webrick/cgi"
class MyCGI < WEBrick::CGI
def do_GET(req, res)
p req.query['q']['content-type'] #=> "plain/text"
end
end
MyCGI.new.start()

• WEBrick::HTTPUtils::FormData

絞り込み条件を変える

CSV::Row#[]=(header, offset, value) (310.0)

• 2.7.0

• インスタンスメソッド

ヘッダの名前でフィールドを探し、値をセットします。

ヘッダの名前でフィールドを探し、値をセットします。

@param header ヘッダの名前を指定します。

@param offset このインデックスより後で、ヘッダの名前を探します。
重複しているヘッダがある場合に便利です。

@param value 値を指定します。

@see CSV::Row#field

• CSV::Row

cgi/session (235.0)

• 2.7.0

• ライブラリ

CGI のセッション管理を行うライブラリ。

CGI のセッション管理を行うライブラリ。

セッションとは、HTTP の一連のリクエストとレスポンスが属するべき
コンテクスト (状況) のことをいいます。
セッション管理には従来通り cgi ライブラリが提供する
クッキーを使用してもいいですが、
この cgi/session を使用した方がよりわかりやすいでしょう。
セッション情報は Hash ライクなインターフェースです。

セッションはセッション ID とプログラムが記録した
セッション情報から構成されます。
デフォルトでは CGI::Session::FileStore が使用され、
記録できるのは文字列のみです。

セッション情報...

• CGI::Session
• CGI::Session::FileStore
• CGI::Session::MemoryStore
• CGI::Session::NoSession
• CGI::Session::NullStore
• cgi/session/pstore

cgi (199.0)

• 2.7.0

• ライブラリ

CGI プログラムの支援ライブラリです。

CGI プログラムの支援ライブラリです。

CGI プロトコルの詳細については以下の文書を参照してください。

* https://tools.ietf.org/html/draft-coar-cgi-v11-03
* 3875: The Common Gateway Interface (CGI) Version 1.1
* https://www.w3.org/CGI/

=== 使用例

==== フォームフィールドの値を得る

//emlist[][ruby]{
require "cgi"
cgi = CGI.new
values = cgi['field_name'] ...

• cgi/cookie
• cgi/core
• cgi/html
• cgi/session
• cgi/session/pstore
• cgi/util

webrick/cgi (145.0)

• 2.7.0

• ライブラリ

一般の CGI 環境で webrick ライブラリのサーブレットと同じように CGI スクリプトを書くための ライブラリです。サーバが WEBrick でなくても使うことが出来ます。

一般の CGI 環境で webrick ライブラリのサーブレットと同じように CGI スクリプトを書くための
ライブラリです。サーバが WEBrick でなくても使うことが出来ます。

=== 使い方

WEBrick のサーブレットを作成するのと同じように、WEBrick::CGI のサブクラスでメソッド
do_GET や do_POST を定義することによって CGI スクリプトを書きます。

スクリプトの最後で WEBrick::CGI#start メソッドを呼ぶ必要があります。
WEBrick::CGI#start メソッドは service メソッドを呼び出し、service メソッ...

• WEBrick::CGI
• WEBrick::CGI::CGIError
• webrick/config
• webrick/cookie
• webrick/htmlutils
• webrick/httprequest
• webrick/httpresponse
• webrick/httpstatus
• webrick/httputils
• webrick/httpversion
• webrick/log
• webrick/utils

Net::HTTPGenericRequest#request_body_permitted? -> bool (73.0)

• 2.7.0

• インスタンスメソッド

リクエストにエンティティボディを一緒に送ることが許されている HTTP メソッド (POST など)の場合真を返します。

リクエストにエンティティボディを一緒に送ることが許されている
HTTP メソッド (POST など)の場合真を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
post = Net::HTTP::Post.new(uri.request_uri)
post.request_body_permitted? # => true

head = Net::HTTP::Head.new(uri.request_uri)
head.request_bo...

• Net::HTTPGenericRequest

絞り込み条件を変える

Net::HTTPGenericRequest#response_body_permitted? -> bool (73.0)

• 2.7.0

• インスタンスメソッド

サーバからのレスポンスにエンティティボディを含むことが許されている HTTP メソッド (GET, POST など)の場合真を返します。

サーバからのレスポンスにエンティティボディを含むことが許されている
HTTP メソッド (GET, POST など)の場合真を返します。

//emlist[例][ruby]{
require 'net/http'

uri = URI.parse('http://www.example.com/index.html')
post = Net::HTTP::Post.new(uri.request_uri)
post.response_body_permitted? # => true

head = Net::HTTP::Head.new(uri.request_uri)
head.r...

• Net::HTTPGenericRequest

OptionParser#on_tail(*arg, &block) -> self (73.0)

• 2.7.0

• インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

--version や --help の説明をサマリの最後に表示したい時に便利です。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tai...

• OptionParser

ruby 1.8.4 feature (55.0)

• 2.7.0

• 文書

ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。

ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

記号について(特に重要なものは大文字(主観))

# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され...

Net::HTTPRequest (37.0)

• 2.7.0

• クラス

HTTP リクエストを抽象化するクラスです。

HTTP リクエストを抽象化するクラスです。

Net::HTTPRequest は抽象クラスなので実際にはサブクラスの

* Net::HTTP::Get
* Net::HTTP::Head
* Net::HTTP::Post
* Net::HTTP::Put
* Net::HTTP::Copy
* Net::HTTP::Delete
* Net::HTTP::Lock
* Net::HTTP::Mkcol
* Net::HTTP::Move
* Net::HTTP::Options
* Net::HTTP::Propfind
* Net::H...

• Net::HTTP::Copy
• Net::HTTP::Delete
• Net::HTTP::Get
• Net::HTTP::Head
• Net::HTTP::Lock
• Net::HTTP::Mkcol
• Net::HTTP::Move
• Net::HTTP::Options
• Net::HTTP::Patch
• Net::HTTP::Post
• Net::HTTP::Propfind
• Net::HTTP::Proppatch
• Net::HTTP::Put
• Net::HTTP::Trace
• Net::HTTP::Unlock

Open3.#pipeline_r(*cmds) -> [IO, [Thread]] (37.0)

• 2.7.0

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の コマンドの標準出力を受けとる事ができます。

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の
コマンドの標準出力を受けとる事ができます。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を Hash で指定します。
...

• Open3

絞り込み条件を変える

Open3.#pipeline_r(*cmds) {|last_stdout, wait_thrs| ... } -> () (37.0)

• 2.7.0

• モジュール関数

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の コマンドの標準出力を受けとる事ができます。

指定したコマンドのリストをパイプで繋いで順番に実行します。最後の
コマンドの標準出力を受けとる事ができます。

@param cmds 実行するコマンドのリストを指定します。それぞれのコマンドは
以下のように String か Array で指定します。
commandline にはコマンド全体(例. "nroff -man")を表す
String を指定します。
options には Hash で指定します。
env には環境変数を Hash で指定します。
...

• Open3

OptionParser#parse!(argv = self.default_argv, into: nil) -> [String] (37.0)

• 2.7.0

• インスタンスメソッド

与えられた argv をパースします。

与えられた argv をパースします。

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプシ...

• OptionParser

OptionParser#parse(*args, into: nil) -> [String] (37.0)

• 2.7.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。

@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option...

• OptionParser

OptionParser#parse(argv, into: nil) -> [String] (37.0)

• 2.7.0

• インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

与えられた argv をパースします。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。

@param args パースしたい引数を順に文字列として与えます。

@param into オプションを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、Option...

• OptionParser

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) -> () (37.0)

• 2.7.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

絞り込み条件を変える

OptionParser#summarize(to = [], width = self.summary_width, max = width - 1, indent= self.summary_indent) {|line| ... } -> () (37.0)

• 2.7.0

• インスタンスメソッド

サマリを指定された to へと加えていきます。

サマリを指定された to へと加えていきます。

ブロックが与えられた場合、サマリの各行を引数としてブロックを評価します。
この場合、ブロックの中で明示的に to へと加えていかない限り、
to にサマリが加えられることはありません。

@param to サマリを出力するオブジェクトを指定します。to には << メソッドが定義されいる必要があります。

@param width サマリの幅を整数で指定します。

@param max サマリの最大幅を整数で指定します。

@param indent サマリのインデントを文字列で指定します。

//emlist[例][ruby]{
requ...

• OptionParser

OptionParser#summary_indent -> String (37.0)

• 2.7.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で返します。

サマリを表示する時のインデントを文字列で返します。

@return サマリを表示する時のインデントを文字列で返します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_indent # => " "
opts.summarize
# => [" -i,...

• OptionParser

OptionParser#summary_indent=(indent) (37.0)

• 2.7.0

• インスタンスメソッド

サマリを表示する時のインデントを文字列で指定します。

サマリを表示する時のインデントを文字列で指定します。

@param indent サマリを表示する時に使われるインデントを文字列で指定します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_indent # => " "
opts.summarize
# ...

• OptionParser

OptionParser#summary_width -> Integer (37.0)

• 2.7.0

• インスタンスメソッド

サマリを表示するときの幅を整数で返します。

サマリを表示するときの幅を整数で返します。

@return サマリを表示するときの幅を整数で返します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n", " ...

• OptionParser

OptionParser#summary_width=(width) (37.0)

• 2.7.0

• インスタンスメソッド

サマリを表示するときの幅を整数で指定します。

サマリを表示するときの幅を整数で指定します。

@param width サマリを表示するときの幅を整数で指定します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.summary_width # => 32
opts.summarize
# => [" -i, --init\n"...

• OptionParser

絞り込み条件を変える

OptionParser#to_a -> [String] (37.0)

• 2.7.0

• インスタンスメソッド

サマリの各行を要素とした配列を返します。

サマリの各行を要素とした配列を返します。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end

opts.to_a # => ["Usage: test [options]", " -i, --init\n", " -u, --update\n", " -h, --help\n"]
//}

• OptionParser

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

• 2.7.0

• インスタンスメソッド

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

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

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

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

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

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

• 2.7.0

• インスタンスメソッド

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

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

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

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

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

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

• 2.7.0

• インスタンスメソッド

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

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

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

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

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

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

• 2.7.0

• インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える