模組 Net::HTTPHeader
HTTPHeader 模組提供存取 HTTP 標頭的功能。
模組包含在
標頭是稱為欄位的鍵/值對的類雜湊集合。
請求和回應欄位¶ ↑
標頭可能包含在
-
一個
Net::HTTPRequest
物件:物件的標頭將隨請求一起傳送。任何欄位都可以在請求中定義;請參閱 設定器。 -
一個
Net::HTTPResponse
物件:物件標頭通常是從主機傳回的標頭。欄位可以從物件中擷取;請參閱 取得器 和 迭代器。
應該傳送或預期的欄位取決於主機;請參閱
關於範例¶ ↑
此處的範例假設已載入 net/http
(這也會載入 uri
)
require 'net/http'
此處的許多程式碼範例使用這些範例網站
有些範例也假設這些變數
uri = URI('https://jsonplaceholder.typicode.com/') uri.freeze # Examples may not modify. hostname = uri.hostname # => "jsonplaceholder.typicode.com" path = uri.path # => "/" port = uri.port # => 443
因此範例請求可以寫成
Net::HTTP.get(uri) Net::HTTP.get(hostname, '/index.html') Net::HTTP.start(hostname) do |http| http.get('/todos/1') http.get('/todos/2') end
一個需要修改的 URI
範例會先複製 uri
,然後修改複製後的內容
_uri = uri.dup _uri.path = '/todos/1'
欄位¶ ↑
標頭欄位是一組金鑰/值。
欄位金鑰¶ ↑
欄位金鑰可以是
-
字串:金鑰
'Accept'
會被視為'Accept'.downcase
;亦即'accept'
。 -
符號:金鑰
:Accept
會被視為:Accept.to_s.downcase
;亦即'accept'
。
範例
req = Net::HTTP::Get.new(uri) req[:accept] # => "*/*" req['Accept'] # => "*/*" req['ACCEPT'] # => "*/*" req['accept'] = 'text/html' req[:accept] = 'text/html' req['ACCEPT'] = 'text/html'
欄位值¶ ↑
欄位值可以回傳為字串陣列或字串
-
下列方法會回傳欄位值為陣列
-
get_fields
:回傳給定金鑰的陣列值,或在不存在時回傳nil
。 -
to_hash
:回傳所有標頭欄位的雜湊:每個金鑰都是欄位名稱;其值是欄位的陣列值。
-
-
下列方法會回傳欄位值為字串;欄位的字串值等於
self[key.downcase.to_s].join(', '))
欄位值可以設定
欄位值範例
-
字串
req['Accept'] = 'text/html' # => "text/html" req['Accept'] # => "text/html" req.get_fields('Accept') # => ["text/html"]
-
符號
req['Accept'] = :text # => :text req['Accept'] # => "text" req.get_fields('Accept') # => ["text"]
-
簡單陣列
req[:foo] = %w[bar baz bat] req[:foo] # => "bar, baz, bat" req.get_fields(:foo) # => ["bar", "baz", "bat"]
-
簡單雜湊
req[:foo] = {bar: 0, baz: 1, bat: 2} req[:foo] # => "bar, 0, baz, 1, bat, 2" req.get_fields(:foo) # => ["bar", "0", "baz", "1", "bat", "2"]
-
巢狀
req[:foo] = [%w[bar baz], {bat: 0, bam: 1}] req[:foo] # => "bar, baz, bat, 0, bam, 1" req.get_fields(:foo) # => ["bar", "baz", "bat", "0", "bam", "1"] req[:foo] = {bar: %w[baz bat], bam: {bah: 0, bad: 1}} req[:foo] # => "bar, baz, bat, bam, bah, 0, bad, 1" req.get_fields(:foo) # => ["bar", "baz", "bat", "bam", "bah", "0", "bad", "1"]
便利方法¶ ↑
各種便利方法會擷取值、設定值、查詢值、設定表單值或反覆運算欄位。
設定器¶ ↑
方法 []=
可以設定任何欄位,但幾乎不會驗證新值;其他一些設定器方法會提供一些驗證
-
[]=
:設定給定金鑰的字串或陣列值。 -
add_field
:建立或新增給定金鑰的陣列值。 -
basic_auth
:設定'Authorization'
的字串授權標頭。 -
content_length=
:設定欄位'Content-Length
的整數長度。 -
content_type=
:設定欄位'Content-Type'
的字串值。 -
proxy_basic_auth
:設定'Proxy-Authorization'
的字串授權標頭。 -
set_range
:設定欄位'Range'
的值。
表單設定器¶ ↑
-
set_form
:設定 HTML 表單資料集。 -
set_form_data
:從 HTML 表單資料設定標頭欄位和主體。
取得器¶ ↑
方法 []
可以擷取任何現有欄位的值,但總是作為字串;其他一些取得器方法會傳回與單純字串值不同的內容
-
[]
:傳回給定金鑰的字串欄位值。 -
content_length
:傳回欄位'Content-Length'
的整數值。 -
content_range
:傳回欄位'Content-Range'
的Range
值。 -
content_type
:傳回欄位'Content-Type'
的字串值。 -
fetch
:傳回給定金鑰的字串欄位值。 -
get_fields
:傳回給定key
的陣列欄位值。 -
main_type
:傳回欄位'Content-Type'
的字串值的開頭部分。 -
sub_type
:傳回欄位'Content-Type'
的字串值的第二部分。 -
range_length
:傳回欄位'Content-Range'
中給定的範圍整數長度。 -
type_params
:傳回'Content-Type'
的字串參數。
查詢¶ ↑
-
chunked?
:傳回欄位'Transfer-Encoding'
是否設為'chunked'
。 -
connection_close?
:傳回欄位'Connection'
是否設為'close'
。 -
connection_keep_alive?
:傳回欄位'Connection'
是否設為'keep-alive'
。 -
key?
:傳回給定的金鑰是否存在。
反覆運算器¶ ↑
-
each_capitalized
:將每個欄位大寫名稱/值對傳遞至區塊。 -
each_capitalized_name
:將每個大寫欄位名稱傳遞至區塊。 -
each_header
:將每個欄位名稱/值對傳遞至區塊。 -
each_name
:將每個欄位名稱傳遞至區塊。 -
each_value
:將每個字串欄位值傳遞至區塊。
常數
- MAX_FIELD_LENGTH
- MAX_KEY_LENGTH
公開實例方法
將不分大小寫 key
的值設為 val
,如果欄位存在,則覆寫前一個值;請參閱 欄位
req = Net::HTTP::Get.new(uri) req['Accept'] # => "*/*" req['Accept'] = 'text/html' req['Accept'] # => "text/html"
請注意,有些欄位值可能會透過方便的方法設定;請參閱 設定器。
# File lib/net/http/header.rb, line 240 def []=(key, val) unless val @header.delete key.downcase.to_s return val end set_field(key, val) end
如果欄位存在,則將值 val
新增到欄位 key
的值陣列中;如果欄位不存在,則使用指定的 key
和 val
建立欄位。請參閱 欄位
req = Net::HTTP::Get.new(uri) req.add_field('Foo', 'bar') req['Foo'] # => "bar" req.add_field('Foo', 'baz') req['Foo'] # => "bar, baz" req.add_field('Foo', %w[baz bam]) req['Foo'] # => "bar, baz, baz, bam" req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"]
# File lib/net/http/header.rb, line 261 def add_field(key, val) stringified_downcased_key = key.downcase.to_s if @header.key?(stringified_downcased_key) append_field_value(@header[stringified_downcased_key], val) else set_field(key, val) end end
使用指定的 account
和 password
字串設定標頭 'Authorization'
req.basic_auth('my_account', 'my_password') req['Authorization'] # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
# File lib/net/http/header.rb, line 945 def basic_auth(account, password) @header['authorization'] = [basic_encode(account, password)] end
如果欄位 'Transfer-Encoding'
存在且值為 'chunked'
,則傳回 true
;否則傳回 false
;請參閱 Transfer-Encoding 回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['Transfer-Encoding'] # => "chunked" res.chunked? # => true
# File lib/net/http/header.rb, line 654 def chunked? return false unless @header['transfer-encoding'] field = self['Transfer-Encoding'] (/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false end
傳回 HTTP
會話是否要關閉。
# File lib/net/http/header.rb, line 966 def connection_close? token = /(?:\A|,)\s*close\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end
傳回 HTTP
會話是否要保持連線。
# File lib/net/http/header.rb, line 974 def connection_keep_alive? token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i @header['connection']&.grep(token) {return true} @header['proxy-connection']&.grep(token) {return true} false end
傳回欄位 'Content-Length'
的值(整數),如果沒有此欄位,則傳回 nil
;請參閱 Content-Length 要求標頭
res = Net::HTTP.get_response(hostname, '/nosuch/1') res.content_length # => 2 res = Net::HTTP.get_response(hostname, '/todos/1') res.content_length # => nil
# File lib/net/http/header.rb, line 616 def content_length return nil unless key?('Content-Length') len = self['Content-Length'].slice(/\d+/) or raise Net::HTTPHeaderSyntaxError, 'wrong Content-Length format' len.to_i end
將欄位 'Content-Length'
的值設定為指定的數字;請參閱 Content-Length 回應標頭
_uri = uri.dup hostname = _uri.hostname # => "jsonplaceholder.typicode.com" _uri.path = '/posts' # => "/posts" req = Net::HTTP::Post.new(_uri) # => #<Net::HTTP::Post POST> req.body = '{"title": "foo","body": "bar","userId": 1}' req.content_length = req.body.size # => 42 req.content_type = 'application/json' res = Net::HTTP.start(hostname) do |http| http.request(req) end # => #<Net::HTTPCreated 201 Created readbody=true>
# File lib/net/http/header.rb, line 637 def content_length=(len) unless len @header.delete 'content-length' return nil end @header['content-length'] = [len.to_i.to_s] end
傳回 Range
物件,代表欄位 'Content-Range'
的值,如果沒有此欄位,則傳回 nil
;請參閱 Content-Range 回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['Content-Range'] # => nil res['Content-Range'] = 'bytes 0-499/1000' res['Content-Range'] # => "bytes 0-499/1000" res.content_range # => 0..499
# File lib/net/http/header.rb, line 670 def content_range return nil unless @header['content-range'] m = %r<\A\s*(\w+)\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range']) or raise Net::HTTPHeaderSyntaxError, 'wrong Content-Range format' return unless m[1] == 'bytes' m[2].to_i .. m[3].to_i end
從欄位 'Content-Type'
的值傳回 媒體類型,如果沒有此欄位,則傳回 nil
;請參閱 Content-Type 回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.content_type # => "application/json"
# File lib/net/http/header.rb, line 701 def content_type main = main_type() return nil unless main sub = sub_type() if sub "#{main}/#{sub}" else main end end
移除給定不區分大小寫的 key
的標頭(請參閱 欄位);傳回已刪除的值,或如果沒有此欄位,則傳回 nil
req = Net::HTTP::Get.new(uri) req.delete('Accept') # => ["*/*"] req.delete('Nosuch') # => nil
# File lib/net/http/header.rb, line 453 def delete(key) @header.delete(key.downcase.to_s) end
類似於 each_header
,但以大寫形式傳回金鑰。
Net::HTTPHeader#canonical_each
是 Net::HTTPHeader#each_capitalized
的別名。
# File lib/net/http/header.rb, line 484 def each_capitalized block_given? or return enum_for(__method__) { @header.size } @header.each do |k,v| yield capitalize(k), v.join(', ') end end
使用每個大寫欄位名稱呼叫區塊
res = Net::HTTP.get_response(hostname, '/todos/1') res.each_capitalized_name do |key| p key if key.start_with?('C') end
輸出
"Content-Type" "Connection" "Cache-Control" "Cf-Cache-Status" "Cf-Ray"
大寫取決於系統;請參閱 大小寫對應。
如果未提供區塊,則傳回列舉器。
# File lib/net/http/header.rb, line 417 def each_capitalized_name #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key do |k| yield capitalize(k) end end
使用每個金鑰/值對呼叫區塊
res = Net::HTTP.get_response(hostname, '/todos/1') res.each_header do |key, value| p [key, value] if key.start_with?('c') end
輸出
["content-type", "application/json; charset=utf-8"] ["connection", "keep-alive"] ["cache-control", "max-age=43200"] ["cf-cache-status", "HIT"] ["cf-ray", "771d17e9bc542cf5-ORD"]
如果未提供區塊,則傳回列舉器。
Net::HTTPHeader#each
是 Net::HTTPHeader#each_header
的別名。
# File lib/net/http/header.rb, line 364 def each_header #:yield: +key+, +value+ block_given? or return enum_for(__method__) { @header.size } @header.each do |k,va| yield k, va.join(', ') end end
使用每個欄位金鑰呼叫區塊
res = Net::HTTP.get_response(hostname, '/todos/1') res.each_key do |key| p key if key.start_with?('c') end
輸出
"content-type" "connection" "cache-control" "cf-cache-status" "cf-ray"
如果未提供區塊,則傳回列舉器。
Net::HTTPHeader#each_name
是 Net::HTTPHeader#each_key
的別名。
# File lib/net/http/header.rb, line 391 def each_name(&block) #:yield: +key+ block_given? or return enum_for(__method__) { @header.size } @header.each_key(&block) end
使用每個字串欄位值呼叫區塊
res = Net::HTTP.get_response(hostname, '/todos/1') res.each_value do |value| p value if value.start_with?('c') end
輸出
"chunked" "cf-q-config;dur=6.0000002122251e-06" "cloudflare"
如果未提供區塊,則傳回列舉器。
# File lib/net/http/header.rb, line 438 def each_value #:yield: +value+ block_given? or return enum_for(__method__) { @header.size } @header.each_value do |va| yield va.join(', ') end end
使用區塊時,如果 key
存在,則傳回其字串值;否則,傳回區塊的值;忽略 default_val
;請參閱 欄位
res = Net::HTTP.get_response(hostname, '/todos/1') # Field exists; block not called. res.fetch('Connection') do |value| fail 'Cannot happen' end # => "keep-alive" # Field does not exist; block called. res.fetch('Nosuch') do |value| value.downcase end # => "nosuch"
如果沒有區塊,則如果 key
存在,則傳回其字串值;否則,如果已提供 default_val
,則傳回 default_val
;否則,引發例外狀況
res.fetch('Connection', 'Foo') # => "keep-alive" res.fetch('Nosuch', 'Foo') # => "Foo" res.fetch('Nosuch') # Raises KeyError.
# File lib/net/http/header.rb, line 341 def fetch(key, *args, &block) #:yield: +key+ a = @header.fetch(key.downcase.to_s, *args, &block) a.kind_of?(Array) ? a.join(', ') : a end
傳回給定 key
的陣列欄位值,或在沒有此欄位時傳回 nil
;請參閱 欄位
res = Net::HTTP.get_response(hostname, '/todos/1') res.get_fields('Connection') # => ["keep-alive"] res.get_fields('Nosuch') # => nil
# File lib/net/http/header.rb, line 306 def get_fields(key) stringified_downcased_key = key.downcase.to_s return nil unless @header[stringified_downcased_key] @header[stringified_downcased_key].dup end
如果欄位存在於不分大小寫的 key
中,則傳回 true
,否則傳回 false
req = Net::HTTP::Get.new(uri) req.key?('Accept') # => true req.key?('Nosuch') # => false
# File lib/net/http/header.rb, line 463 def key?(key) @header.key?(key.downcase.to_s) end
從欄位 'Content-Type'
的值傳回 媒體類型 的前導(「類型」)部分,或在沒有此欄位時傳回 nil
;請參閱 Content-Type 回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.main_type # => "application"
# File lib/net/http/header.rb, line 723 def main_type return nil unless @header['content-type'] self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip end
使用給定的 account
和 password
字串設定標頭 'Proxy-Authorization'
req.proxy_basic_auth('my_account', 'my_password') req['Proxy-Authorization'] # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
# File lib/net/http/header.rb, line 956 def proxy_basic_auth(account, password) @header['proxy-authorization'] = [basic_encode(account, password)] end
傳回表示欄位 'Range'
值的 Range
物件陣列,或在沒有此欄位時傳回 nil
;請參閱 範圍要求標頭
req = Net::HTTP::Get.new(uri) req['Range'] = 'bytes=0-99,200-299,400-499' req.range # => [0..99, 200..299, 400..499] req.delete('Range') req.range # # => nil
# File lib/net/http/header.rb, line 509 def range return nil unless @header['range'] value = self['Range'] # byte-range-set = *( "," OWS ) ( byte-range-spec / suffix-byte-range-spec ) # *( OWS "," [ OWS ( byte-range-spec / suffix-byte-range-spec ) ] ) # corrected collected ABNF # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#section-5.4.1 # http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-C # http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-19#section-3.2.5 unless /\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/ =~ value raise Net::HTTPHeaderSyntaxError, "invalid syntax for byte-ranges-specifier: '#{value}'" end byte_range_set = $1 result = byte_range_set.split(/,/).map {|spec| m = /(\d+)?\s*-\s*(\d+)?/i.match(spec) or raise Net::HTTPHeaderSyntaxError, "invalid byte-range-spec: '#{spec}'" d1 = m[1].to_i d2 = m[2].to_i if m[1] and m[2] if d1 > d2 raise Net::HTTPHeaderSyntaxError, "last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'" end d1..d2 elsif m[1] d1..-1 elsif m[2] -d2..-1 else raise Net::HTTPHeaderSyntaxError, 'range is not specified' end } # if result.empty? # byte-range-set must include at least one byte-range-spec or suffix-byte-range-spec # but above regexp already denies it. if result.size == 1 && result[0].begin == 0 && result[0].end == -1 raise Net::HTTPHeaderSyntaxError, 'only one suffix-byte-range-spec with zero suffix-length' end result end
傳回表示欄位 'Content-Range'
值的長度的整數,或在沒有此欄位時傳回 nil
;請參閱 Content-Range 回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['Content-Range'] # => nil res['Content-Range'] = 'bytes 0-499/1000' res.range_length # => 500
# File lib/net/http/header.rb, line 687 def range_length r = content_range() or return nil r.end - r.begin + 1 end
設定欄位 'Content-Type'
的值;傳回新值;請參閱 Content-Type 要求標頭
req = Net::HTTP::Get.new(uri) req.set_content_type('application/json') # => ["application/json"]
Net::HTTPHeader#content_type=
是 Net::HTTPHeader#set_content_type
的別名。
# File lib/net/http/header.rb, line 772 def set_content_type(type, params = {}) @header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')] end
儲存將用於 POST
或 PUT
要求的表單資料。
在 params
中提供的表單資料包含零個或多個欄位;每個欄位是
-
一個純量值。
-
一個名稱/值配對。
-
一個開啟用於讀取的
IO
串流。
引數 params
應該是一個 Enumerable(將呼叫方法 params.map
),而且通常是一個陣列或雜湊。
首先,我們設定一個要求
_uri = uri.dup _uri.path ='/posts' req = Net::HTTP::Post.new(_uri)
引數 params
作為一個陣列
當 params
是陣列時,其每個元素都是定義一個欄位的子陣列;子陣列可能包含
-
一個字串
req.set_form([['foo'], ['bar'], ['baz']])
-
兩個字串
req.set_form([%w[foo 0], %w[bar 1], %w[baz 2]])
-
當引數
enctype
(請參閱下方)提供為'multipart/form-data'
時
各種表單可以混合使用
req.set_form(['foo', %w[bar 1], ['file', file]])
引數 params
作為一個雜湊
當 params
是雜湊時,其每個項目都是定義一個欄位的名稱/值配對
-
名稱是一個字串。
-
值可能是
-
nil
. -
另一個字串。
-
一個開啟用於讀取的
IO
串流(僅當引數enctype
– 請參閱下方 – 提供為'multipart/form-data'
時)。
-
範例
# Nil-valued fields. req.set_form({'foo' => nil, 'bar' => nil, 'baz' => nil}) # String-valued fields. req.set_form({'foo' => 0, 'bar' => 1, 'baz' => 2}) # IO-valued field. require 'stringio' req.set_form({'file' => StringIO.new('Ruby is cool.')}) # Mixture of fields. req.set_form({'foo' => nil, 'bar' => 1, 'file' => file})
選用引數 enctype
指定要提供給欄位 'Content-Type'
的值,而且必須是下列其中一個
-
'application/x-www-form-urlencoded'
(預設值)。 -
'multipart/form-data'
;請參閱 RFC 7578。
選用引數 formopt
是選項雜湊(僅當引數 enctype
為 'multipart/form-data'
時適用),其中可能包含下列項目
-
:boundary
:值是 multipart 訊息的邊界字串。如果未提供,邊界會是隨機字串。請參閱 邊界。 -
:charset
:值是表單提交的字元集。非檔案欄位的欄位名稱和值應使用此字元集編碼。
# File lib/net/http/header.rb, line 924 def set_form(params, enctype='application/x-www-form-urlencoded', formopt={}) @body_data = params @body = nil @body_stream = nil @form_option = formopt case enctype when /\Aapplication\/x-www-form-urlencoded\z/i, /\Amultipart\/form-data\z/i self.content_type = enctype else raise ArgumentError, "invalid enctype: #{enctype}" end end
將要求主體設定為從引數 params
衍生的 URL 編碼字串,並將要求標頭欄位 'Content-Type'
設定為 'application/x-www-form-urlencoded'
。
產生的要求適合於 HTTP
要求 POST
或 PUT
。
引數 params
必須適合用於 URI.encode_www_form
的引數 enum
。
僅提供引數 params
時,將主體設定為 URL 編碼字串,預設分隔符號為 '&'
req = Net::HTTP::Post.new('example.com') req.set_form_data(q: 'ruby', lang: 'en') req.body # => "q=ruby&lang=en" req['Content-Type'] # => "application/x-www-form-urlencoded" req.set_form_data([['q', 'ruby'], ['lang', 'en']]) req.body # => "q=ruby&lang=en" req.set_form_data(q: ['ruby', 'perl'], lang: 'en') req.body # => "q=ruby&q=perl&lang=en" req.set_form_data([['q', 'ruby'], ['q', 'perl'], ['lang', 'en']]) req.body # => "q=ruby&q=perl&lang=en"
同時提供字串引數 sep
時,使用該字串作為分隔符號
req.set_form_data({q: 'ruby', lang: 'en'}, '|') req.body # => "q=ruby|lang=en"
Net::HTTPHeader#form_data=
是 Net::HTTPHeader#set_form_data
的別名。
# File lib/net/http/header.rb, line 812 def set_form_data(params, sep = '&') query = URI.encode_www_form(params) query.gsub!(/&/, sep) if sep != '&' self.body = query self.content_type = 'application/x-www-form-urlencoded' end
設定欄位 'Range'
的值;請參閱 範圍要求標頭
使用引數 length
req = Net::HTTP::Get.new(uri) req.set_range(100) # => 100 req['Range'] # => "bytes=0-99"
使用引數 offset
和 length
req.set_range(100, 100) # => 100...200 req['Range'] # => "bytes=100-199"
使用引數 range
req.set_range(100..199) # => 100..199 req['Range'] # => "bytes=100-199"
Net::HTTPHeader#range=
是 Net::HTTPHeader#set_range
的別名。
# File lib/net/http/header.rb, line 576 def set_range(r, e = nil) unless r @header.delete 'range' return r end r = (r...r+e) if e case r when Numeric n = r.to_i rangestr = (n > 0 ? "0-#{n-1}" : "-#{-n}") when Range first = r.first last = r.end last -= 1 if r.exclude_end? if last == -1 rangestr = (first > 0 ? "#{first}-" : "-#{-first}") else raise Net::HTTPHeaderSyntaxError, 'range.first is negative' if first < 0 raise Net::HTTPHeaderSyntaxError, 'range.last is negative' if last < 0 raise Net::HTTPHeaderSyntaxError, 'must be .first < .last' if first > last rangestr = "#{first}-#{last}" end else raise TypeError, 'Range/Integer is required' end @header['range'] = ["bytes=#{rangestr}"] r end
從欄位 'Content-Type'
的值傳回 媒體類型 的尾端(「子類型」)部分,或如果沒有此類欄位,則傳回 nil
;請參閱 內容類型回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.sub_type # => "json"
# File lib/net/http/header.rb, line 738 def sub_type return nil unless @header['content-type'] _, sub = *self['Content-Type'].split(';').first.to_s.split('/') return nil unless sub sub.strip end
傳回金鑰/值配對的雜湊
req = Net::HTTP::Get.new(uri) req.to_hash # => {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"], "accept"=>["*/*"], "user-agent"=>["Ruby"], "host"=>["jsonplaceholder.typicode.com"]}
# File lib/net/http/header.rb, line 477 def to_hash @header.dup end
傳回欄位 'Content-Type'
的值中尾端的(「參數」)部分,或如果沒有此類欄位,則傳回 nil
;請參閱 內容類型回應標頭
res = Net::HTTP.get_response(hostname, '/todos/1') res['content-type'] # => "application/json; charset=utf-8" res.type_params # => {"charset"=>"utf-8"}
# File lib/net/http/header.rb, line 753 def type_params result = {} list = self['Content-Type'].to_s.split(';') list.shift list.each do |param| k, v = *param.split('=', 2) result[k.strip] = v.strip end result end
私有實例方法
# File lib/net/http/header.rb, line 285 def append_field_value(ary, val) case val when Enumerable val.each{|x| append_field_value(ary, x)} else val = val.to_s if /[\r\n]/n.match?(val.b) raise ArgumentError, 'header field value cannot include CR/LF' end ary.push val end end
# File lib/net/http/header.rb, line 960 def basic_encode(account, password) 'Basic ' + ["#{account}:#{password}"].pack('m0') end
# File lib/net/http/header.rb, line 493 def capitalize(name) name.to_s.split(/-/).map {|s| s.capitalize }.join('-') end
# File lib/net/http/header.rb, line 270 def set_field(key, val) case val when Enumerable ary = [] append_field_value(ary, val) @header[key.downcase.to_s] = ary else val = val.to_s # for compatibility use to_s instead of to_str if val.b.count("\r\n") > 0 raise ArgumentError, 'header field value cannot include CR/LF' end @header[key.downcase.to_s] = [val] end end