Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > net/httpライブラリ > Net::HTTPHeaderモジュール

module Net::HTTPHeader

クラスの継承リスト: Net::HTTPHeader

要約

HTTP ヘッダのためのモジュールです。

このモジュールを mix-in に @header という(ハッシュを代入してある) 変数への「大文字小文字を無視した」ハッシュ的アクセスメソッドを提供します。またよくある HTTP ヘッダへの便利なアクセスメソッドも用意します。

インスタンスメソッド

定義 説明
self[key] -> String|nil

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

self[key] = val

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

add_field(key, val) -> ()

key ヘッダフィールドに val を追加します。

basic_auth(account, password) -> [String]

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

each_capitalized {|name, value| .... } -> ()
canonical_each {|name, value| .... } -> ()

ヘッダフィールドの正規化名とその値のペアをブロックに渡し、呼びだします。

chunked? -> bool

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

content_length -> Integer|nil

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

content_length=(len)

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

content_range -> Range|nil

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

content_type -> String|nil

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

content_type=(type)
set_content_type(type, params = {})

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

delete(key) -> String | nil

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

each {|name, val| .... } -> ()
each_header {|name, val| .... } -> ()

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

each_capitalized_name {|name| .... } -> ()

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

each_name {|name| ... } -> ()
each_key {|name| ... } -> ()

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

each_value {|value| .... } -> ()

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

fetch(key) -> String
fetch(key, default) -> String
fetch(key) {|hash| .... } -> String

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

form_data=(params)
set_form_data(params, sep = '&') -> ()

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

get_fields(key) -> [String]

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

key?(key) -> bool

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

size -> Integer
length -> Integer

このメソッドは obsolete です。

main_type -> String|nil

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

method -> String

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

proxy_basic_auth(account, password) -> [String]

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

range -> Range|nil

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

range=(r)
range=(n)
set_range(i, len) -> ()
set_range(r) -> ()
set_range(n) -> ()

範囲を指定してエンティティを取得するためのヘッダ Range: をセットします。

range_length -> Integer|nil

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

sub_type -> String|nil

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

type_params -> Hash

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