module Net::HTTPHeader

The HTTPHeader module provides access to HTTP headers.

The module is included in:

Net::HTTPGenericRequest (and thereforeNet::HTTPRequest).
Net::HTTPResponse.

The headers are a hash-like collection of key/value pairs calledfields.

Request and Response Fields¶↑

Headers may be included in:

ANet::HTTPRequest object: the object’s headers will be sent with the request. Any fields may be defined in the request; seeSetters.
ANet::HTTPResponse object: the objects headers are usually those returned from the host. Fields may be retrieved from the object; seeGetters andIterators.

Exactly which fields should be sent or expected depends on the host; see:

About the Examples¶↑

Examples here assume thatnet/http has been required (which also requiresuri):

require'net/http'

Many code examples here use these example websites:

Some examples also assume these variables:

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

So that example requests may be written as:

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

An example that needs a modifiedURI first duplicatesuri, then modifies the duplicate:

_uri =uri.dup_uri.path ='/todos/1'

Fields¶↑

A header field is a key/value pair.

Field Keys¶↑

A field key may be:

A string: Key'Accept' is treated as if it were'Accept'.downcase; i.e.,'accept'.
A symbol: Key:Accept is treated as if it were:Accept.to_s.downcase; i.e.,'accept'.

Examples:

req =Net::HTTP::Get.new(uri)req[:accept]# => "*/*"req['Accept']# => "*/*"req['ACCEPT']# => "*/*"req['accept'] ='text/html'req[:accept] ='text/html'req['ACCEPT'] ='text/html'

Field Values¶↑

A field value may be returned as an array of strings or as a string:

These methods return field values as arrays:
- get_fields: Returns the array value for the given key, ornil if it does not exist.
- to_hash: Returns a hash of all header fields: each key is a field name; its value is the array value for the field.
These methods return field values as string; the string value for a field is equivalent toself[key.downcase.to_s].join(', ')):
- []: Returns the string value for the given key, ornil if it does not exist.
- fetch: Like[], but accepts a default value to be returned if the key does not exist.

The field value may be set:

[]=: Sets the value for the given key; the given value may be a string, a symbol, an array, or a hash.
add_field: Adds a given value to a value for the given key (not overwriting the existing value).
delete: Deletes the field for the given key.

Example field values:

String:

req['Accept'] ='text/html'# => "text/html"req['Accept']# => "text/html"req.get_fields('Accept')# => ["text/html"]

Symbol:

req['Accept'] =:text# => :textreq['Accept']# => "text"req.get_fields('Accept')# => ["text"]

Simple array:

req[:foo] =%w[bar baz bat]req[:foo]# => "bar, baz, bat"req.get_fields(:foo)# => ["bar", "baz", "bat"]

Simple hash:

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"]

Nested:

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"]

Convenience Methods¶↑

Various convenience methods retrieve values, set values, query values, set form values, or iterate over fields.

Setters¶↑

Method[]= can set any field, but does little to validate the new value; some of the other setter methods provide some validation:

[]=: Sets the string or array value for the given key.
add_field: Creates or adds to the array value for the given key.
basic_auth: Sets the string authorization header for'Authorization'.
content_length=: Sets the integer length for field'Content-Length.
content_type=: Sets the string value for field'Content-Type'.
proxy_basic_auth: Sets the string authorization header for'Proxy-Authorization'.
set_range: Sets the value for field'Range'.

Form Setters¶↑

set_form: Sets an HTML form data set.
set_form_data: Sets header fields and a body from HTML form data.

Getters¶↑

Method[] can retrieve the value of any field that exists, but always as a string; some of the other getter methods return something different from the simple string value:

[]: Returns the string field value for the given key.
content_length: Returns the integer value of field'Content-Length'.
content_range: Returns theRange value of field'Content-Range'.
content_type: Returns the string value of field'Content-Type'.
fetch: Returns the string field value for the given key.
get_fields: Returns the array field value for the givenkey.
main_type: Returns first part of the string value of field'Content-Type'.
sub_type: Returns second part of the string value of field'Content-Type'.
range: Returns an array ofRange objects of field'Range', ornil.
range_length: Returns the integer length of the range given in field'Content-Range'.
type_params: Returns the string parameters for'Content-Type'.

Queries¶↑

chunked?: Returns whether field'Transfer-Encoding' is set to'chunked'.
connection_close?: Returns whether field'Connection' is set to'close'.
connection_keep_alive?: Returns whether field'Connection' is set to'keep-alive'.
key?: Returns whether a given key exists.

Iterators¶↑

each_capitalized: Passes each field capitalized-name/value pair to the block.
each_capitalized_name: Passes each capitalized field name to the block.
each_header: Passes each field name/value pair to the block.
each_name: Passes each field name to the block.
each_value: Passes each string field value to the block.

Constants

MAX_FIELD_LENGTH
MAX_KEY_LENGTH

Public Instance Methods

[](key)

Source

# File lib/net/http/header.rb, line 224def[](key)a =@header[key.downcase.to_s]orreturnnila.join(', ')end

Returns the string field value for the case-insensitive fieldkey, ornil if there is no such key; seeFields:

res =Net::HTTP.get_response(hostname,'/todos/1')res['Connection']# => "keep-alive"res['Nosuch']# => nil

Note that some field values may be retrieved via convenience methods; seeGetters.

[]=(key, val)

Source

# File lib/net/http/header.rb, line 240def[]=(key,val)unlessval@header.deletekey.downcase.to_sreturnvalendset_field(key,val)end

Sets the value for the case-insensitivekey toval, overwriting the previous value if the field exists; seeFields:

req =Net::HTTP::Get.new(uri)req['Accept']# => "*/*"req['Accept'] ='text/html'req['Accept']# => "text/html"

Note that some field values may be set via convenience methods; seeSetters.

add_field(key, val)

Source

# File lib/net/http/header.rb, line 261defadd_field(key,val)stringified_downcased_key =key.downcase.to_sif@header.key?(stringified_downcased_key)append_field_value(@header[stringified_downcased_key],val)elseset_field(key,val)endend

Adds valueval to the value array for fieldkey if the field exists; creates the field with the givenkey andval if it does not exist. seeFields:

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"]

basic_auth(account, password)

Source

# File lib/net/http/header.rb, line 945defbasic_auth(account,password)@header['authorization'] = [basic_encode(account,password)]end

Sets header'Authorization' using the givenaccount andpassword strings:

req.basic_auth('my_account','my_password')req['Authorization']# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

canonical_each()

Alias for:each_capitalized

chunked?()

Source

# File lib/net/http/header.rb, line 654defchunked?returnfalseunless@header['transfer-encoding']field =self['Transfer-Encoding']  (/(?:\A|[^\-\w])chunked(?![\-\w])/i=~field)?true:falseend

Returnstrue if field'Transfer-Encoding' exists and has value'chunked',false otherwise; seeTransfer-Encoding response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['Transfer-Encoding']# => "chunked"res.chunked?# => true

connection_close?()

Source

# File lib/net/http/header.rb, line 966defconnection_close?token =/(?:\A|,)\s*close\s*(?:\z|,)/i@header['connection']&.grep(token) {returntrue}@header['proxy-connection']&.grep(token) {returntrue}falseend

Returns whether theHTTP session is to be closed.

connection_keep_alive?()

Source

# File lib/net/http/header.rb, line 974defconnection_keep_alive?token =/(?:\A|,)\s*keep-alive\s*(?:\z|,)/i@header['connection']&.grep(token) {returntrue}@header['proxy-connection']&.grep(token) {returntrue}falseend

Returns whether theHTTP session is to be kept alive.

content_length()

Source

# File lib/net/http/header.rb, line 616defcontent_lengthreturnnilunlesskey?('Content-Length')len =self['Content-Length'].slice(/\d+/)orraiseNet::HTTPHeaderSyntaxError,'wrong Content-Length format'len.to_iend

Returns the value of field'Content-Length' as an integer, ornil if there is no such field; seeContent-Length request header:

res =Net::HTTP.get_response(hostname,'/nosuch/1')res.content_length# => 2res =Net::HTTP.get_response(hostname,'/todos/1')res.content_length# => nil

content_length=(len)

Source

# File lib/net/http/header.rb, line 637defcontent_length=(len)unlesslen@header.delete'content-length'returnnilend@header['content-length'] = [len.to_i.to_s]end

Sets the value of field'Content-Length' to the given numeric; seeContent-Length response header:

_uri =uri.duphostname =_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# => 42req.content_type ='application/json'res =Net::HTTP.start(hostname)do|http|http.request(req)end# => #<Net::HTTPCreated 201 Created readbody=true>

content_range()

Source

# File lib/net/http/header.rb, line 670defcontent_rangereturnnilunless@header['content-range']m =%r<\A\s*(\w+)\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range'])orraiseNet::HTTPHeaderSyntaxError,'wrong Content-Range format'returnunlessm[1]=='bytes'm[2].to_i..m[3].to_iend

Returns aRange object representing the value of field'Content-Range', ornil if no such field exists; seeContent-Range response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['Content-Range']# => nilres['Content-Range'] ='bytes 0-499/1000'res['Content-Range']# => "bytes 0-499/1000"res.content_range# => 0..499

content_type()

Source

# File lib/net/http/header.rb, line 701defcontent_typemain =main_type()returnnilunlessmainsub =sub_type()ifsub"#{main}/#{sub}"elsemainendend

Returns themedia type from the value of field'Content-Type', ornil if no such field exists; seeContent-Type response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['content-type']# => "application/json; charset=utf-8"res.content_type# => "application/json"

content_type=(type, params = {})

Alias for:set_content_type

delete(key)

Source

# File lib/net/http/header.rb, line 453defdelete(key)@header.delete(key.downcase.to_s)end

Removes the header for the given case-insensitivekey (seeFields); returns the deleted value, ornil if no such field exists:

req =Net::HTTP::Get.new(uri)req.delete('Accept')# => ["*/*"]req.delete('Nosuch')# => nil

each()

Alias for:each_header

each_capitalized() { |capitalize(k), join(', ')| ... }

Source

# File lib/net/http/header.rb, line 484defeach_capitalizedblock_given?orreturnenum_for(__method__) {@header.size }@header.eachdo|k,v|yieldcapitalize(k),v.join(', ')endend

Likeeach_header, but the keys are returned in capitalized form.

Net::HTTPHeader#canonical_each is an alias forNet::HTTPHeader#each_capitalized.

Also aliased as:canonical_each

each_capitalized_name() { |key| ... }

Source

# File lib/net/http/header.rb, line 417defeach_capitalized_name#:yield: +key+block_given?orreturnenum_for(__method__) {@header.size }@header.each_keydo|k|yieldcapitalize(k)endend

Calls the block with each capitalized field name:

res =Net::HTTP.get_response(hostname,'/todos/1')res.each_capitalized_namedo|key|pkeyifkey.start_with?('C')end

Output:

"Content-Type""Connection""Cache-Control""Cf-Cache-Status""Cf-Ray"

The capitalization is system-dependent; seeCase Mapping.

Returns an enumerator if no block is given.

each_header() { |key| ... }

Source

# File lib/net/http/header.rb, line 364defeach_header#:yield: +key+, +value+block_given?orreturnenum_for(__method__) {@header.size }@header.eachdo|k,va|yieldk,va.join(', ')endend

Calls the block with each key/value pair:

res =Net::HTTP.get_response(hostname,'/todos/1')res.each_headerdo|key,value|p [key,value]ifkey.start_with?('c')end

Output:

["content-type","application/json; charset=utf-8"]["connection","keep-alive"]["cache-control","max-age=43200"]["cf-cache-status","HIT"]["cf-ray","771d17e9bc542cf5-ORD"]

Returns an enumerator if no block is given.

Net::HTTPHeader#each is an alias forNet::HTTPHeader#each_header.

Also aliased as:each

each_key()

Alias for:each_name

each_name() { |key| ... }

Source

# File lib/net/http/header.rb, line 391defeach_name(&block)#:yield: +key+block_given?orreturnenum_for(__method__) {@header.size }@header.each_key(&block)end

Calls the block with each field key:

res =Net::HTTP.get_response(hostname,'/todos/1')res.each_keydo|key|pkeyifkey.start_with?('c')end

Output:

"content-type""connection""cache-control""cf-cache-status""cf-ray"

Returns an enumerator if no block is given.

Net::HTTPHeader#each_name is an alias forNet::HTTPHeader#each_key.

Also aliased as:each_key

each_value() { |value| ... }

Source

# File lib/net/http/header.rb, line 438defeach_value#:yield: +value+block_given?orreturnenum_for(__method__) {@header.size }@header.each_valuedo|va|yieldva.join(', ')endend

Calls the block with each string field value:

res =Net::HTTP.get_response(hostname,'/todos/1')res.each_valuedo|value|pvalueifvalue.start_with?('c')end

Output:

"chunked""cf-q-config;dur=6.0000002122251e-06""cloudflare"

Returns an enumerator if no block is given.

fetch(key, default_val = nil) {|key| ... } → object

fetch(key, default_val = nil) → value or default_val

Source

# File lib/net/http/header.rb, line 341deffetch(key,*args,&block)#:yield: +key+a =@header.fetch(key.downcase.to_s,*args,&block)a.kind_of?(Array)?a.join(', '):aend

With a block, returns the string value forkey if it exists; otherwise returns the value of the block; ignores thedefault_val; seeFields:

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.downcaseend# => "nosuch"

With no block, returns the string value forkey if it exists; otherwise, returnsdefault_val if it was given; otherwise raises an exception:

res.fetch('Connection','Foo')# => "keep-alive"res.fetch('Nosuch','Foo')# => "Foo"res.fetch('Nosuch')# Raises KeyError.

form_data=(params, sep = '&')

Alias for:set_form_data

get_fields(key)

Source

# File lib/net/http/header.rb, line 306defget_fields(key)stringified_downcased_key =key.downcase.to_sreturnnilunless@header[stringified_downcased_key]@header[stringified_downcased_key].dupend

Returns the array field value for the givenkey, ornil if there is no such field; seeFields:

res =Net::HTTP.get_response(hostname,'/todos/1')res.get_fields('Connection')# => ["keep-alive"]res.get_fields('Nosuch')# => nil

key?(key)

Source

# File lib/net/http/header.rb, line 463defkey?(key)@header.key?(key.downcase.to_s)end

Returnstrue if the field for the case-insensitivekey exists,false otherwise:

req =Net::HTTP::Get.new(uri)req.key?('Accept')# => truereq.key?('Nosuch')# => false

main_type()

Source

# File lib/net/http/header.rb, line 723defmain_typereturnnilunless@header['content-type']self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.stripend

Returns the leading (‘type’) part of themedia type from the value of field'Content-Type', ornil if no such field exists; seeContent-Type response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['content-type']# => "application/json; charset=utf-8"res.main_type# => "application"

proxy_basic_auth(account, password)

Source

# File lib/net/http/header.rb, line 956defproxy_basic_auth(account,password)@header['proxy-authorization'] = [basic_encode(account,password)]end

Sets header'Proxy-Authorization' using the givenaccount andpassword strings:

req.proxy_basic_auth('my_account','my_password')req['Proxy-Authorization']# => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="

range()

Source

# File lib/net/http/header.rb, line 509defrangereturnnilunless@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.5unless/\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/=~valueraiseNet::HTTPHeaderSyntaxError,"invalid syntax for byte-ranges-specifier: '#{value}'"endbyte_range_set =$1result =byte_range_set.split(/,/).map {|spec|m =/(\d+)?\s*-\s*(\d+)?/i.match(spec)orraiseNet::HTTPHeaderSyntaxError,"invalid byte-range-spec: '#{spec}'"d1 =m[1].to_id2 =m[2].to_iifm[1]andm[2]ifd1>d2raiseNet::HTTPHeaderSyntaxError,"last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'"endd1..d2elsifm[1]d1..-1elsifm[2]-d2..-1elseraiseNet::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.ifresult.size==1&&result[0].begin==0&&result[0].end==-1raiseNet::HTTPHeaderSyntaxError,'only one suffix-byte-range-spec with zero suffix-length'endresultend

Returns an array ofRange objects that represent the value of field'Range', ornil if there is no such field; seeRange request header:

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

range=

Alias for:set_range

range_length()

Source

# File lib/net/http/header.rb, line 687defrange_lengthr =content_range()orreturnnilr.end-r.begin+1end

Returns the integer representing length of the value of field'Content-Range', ornil if no such field exists; seeContent-Range response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['Content-Range']# => nilres['Content-Range'] ='bytes 0-499/1000'res.range_length# => 500

set_content_type(type, params = {})

Source

# File lib/net/http/header.rb, line 772defset_content_type(type,params = {})@header['content-type'] = [type+params.map{|k,v|"; #{k}=#{v}"}.join('')]end

Sets the value of field'Content-Type'; returns the new value; seeContent-Type request header:

req =Net::HTTP::Get.new(uri)req.set_content_type('application/json')# => ["application/json"]

Net::HTTPHeader#content_type= is an alias forNet::HTTPHeader#set_content_type.

Also aliased as:content_type=

set_form(params, enctype='application/x-www-form-urlencoded', formopt={})

Source

# File lib/net/http/header.rb, line 924defset_form(params,enctype='application/x-www-form-urlencoded',formopt={})@body_data =params@body =nil@body_stream =nil@form_option =formoptcaseenctypewhen/\Aapplication\/x-www-form-urlencoded\z/i,/\Amultipart\/form-data\z/iself.content_type =enctypeelseraiseArgumentError,"invalid enctype: #{enctype}"endend

Stores form data to be used in aPOST orPUT request.

The form data given inparams consists of zero or more fields; each field is:

A scalar value.
A name/value pair.
AnIO stream opened for reading.

Argumentparams should be anEnumerable (methodparams.map will be called), and is often an array or hash.

First, we set up a request:

_uri =uri.dup_uri.path ='/posts'req =Net::HTTP::Post.new(_uri)

Argumentparams As an Array

Whenparams is an array, each of its elements is a subarray that defines a field; the subarray may contain:

One string:

req.set_form([['foo'], ['bar'], ['baz']])

Two strings:

req.set_form([%w[foo 0],%w[bar 1],%w[baz 2]])

When argumentenctype (see below) is given as'multipart/form-data':
- A string name and anIO stream opened for reading:
```
require'stringio'req.set_form([['file',StringIO.new('Ruby is cool.')]])
```
- A string name, anIO stream opened for reading, and an options hash, which may contain these entries:
  - :filename: The name of the file to use.
  - :content_type: The content type of the uploaded file.
  Example:
```
req.set_form([['file', file, {filename: "other-filename.foo"}]]
```

The various forms may be mixed:

req.set_form(['foo',%w[bar 1], ['file',file]])

Argumentparams As a Hash

Whenparams is a hash, each of its entries is a name/value pair that defines a field:

The name is a string.
The value may be:
- nil.
- Another string.
- AnIO stream opened for reading (only when argumentenctype – see below – is given as'multipart/form-data').

Examples:

# 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})

Optional argumentenctype specifies the value to be given to field'Content-Type', and must be one of:

'application/x-www-form-urlencoded' (the default).
'multipart/form-data'; seeRFC 7578.

Optional argumentformopt is a hash of options (applicable only when argumentenctype is'multipart/form-data') that may include the following entries:

:boundary: The value is the boundary string for the multipart message. If not given, the boundary is a random string. SeeBoundary.
:charset: Value is the character set for the form submission. Field names and values of non-file fields should be encoded with this charset.

set_form_data(params, sep = '&')

Source

# File lib/net/http/header.rb, line 812defset_form_data(params,sep ='&')query =URI.encode_www_form(params)query.gsub!(/&/,sep)ifsep!='&'self.body =queryself.content_type ='application/x-www-form-urlencoded'end

Sets the request body to a URL-encoded string derived from argumentparams, and sets request header field'Content-Type' to'application/x-www-form-urlencoded'.

The resulting request is suitable forHTTP requestPOST orPUT.

Argumentparams must be suitable for use as argumentenum toURI.encode_www_form.

With only argumentparams given, sets the body to a URL-encoded string with the default separator'&':

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"

With string argumentsep also given, uses that string as the separator:

req.set_form_data({q:'ruby',lang:'en'},'|')req.body# => "q=ruby|lang=en"

Net::HTTPHeader#form_data= is an alias forNet::HTTPHeader#set_form_data.

Also aliased as:form_data=

set_range(length) → length

set_range(offset, length) → range

set_range(begin..length) → range

Source

# File lib/net/http/header.rb, line 576defset_range(r,e =nil)unlessr@header.delete'range'returnrendr = (r...r+e)ifecaserwhenNumericn =r.to_irangestr = (n>0?"0-#{n-1}":"-#{-n}")whenRangefirst =r.firstlast =r.endlast-=1ifr.exclude_end?iflast==-1rangestr = (first>0?"#{first}-":"-#{-first}")elseraiseNet::HTTPHeaderSyntaxError,'range.first is negative'iffirst<0raiseNet::HTTPHeaderSyntaxError,'range.last is negative'iflast<0raiseNet::HTTPHeaderSyntaxError,'must be .first < .last'iffirst>lastrangestr ="#{first}-#{last}"endelseraiseTypeError,'Range/Integer is required'end@header['range'] = ["bytes=#{rangestr}"]rend

Sets the value for field'Range'; seeRange request header:

With argumentlength:

req =Net::HTTP::Get.new(uri)req.set_range(100)# => 100req['Range']# => "bytes=0-99"

With argumentsoffset andlength:

req.set_range(100,100)# => 100...200req['Range']# => "bytes=100-199"

With argumentrange:

req.set_range(100..199)# => 100..199req['Range']# => "bytes=100-199"

Net::HTTPHeader#range= is an alias forNet::HTTPHeader#set_range.

Also aliased as:range=

sub_type()

Source

# File lib/net/http/header.rb, line 738defsub_typereturnnilunless@header['content-type']_,sub =*self['Content-Type'].split(';').first.to_s.split('/')returnnilunlesssubsub.stripend

Returns the trailing (‘subtype’) part of themedia type from the value of field'Content-Type', ornil if no such field exists; seeContent-Type response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['content-type']# => "application/json; charset=utf-8"res.sub_type# => "json"

to_hash()

Source

# File lib/net/http/header.rb, line 477defto_hash@header.dupend

Returns a hash of the key/value pairs:

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"]}

type_params()

Source

# File lib/net/http/header.rb, line 753deftype_paramsresult = {}list =self['Content-Type'].to_s.split(';')list.shiftlist.eachdo|param|k,v =*param.split('=',2)result[k.strip] =v.stripendresultend

Returns the trailing (‘parameters’) part of the value of field'Content-Type', ornil if no such field exists; seeContent-Type response header:

res =Net::HTTP.get_response(hostname,'/todos/1')res['content-type']# => "application/json; charset=utf-8"res.type_params# => {"charset"=>"utf-8"}

Private Instance Methods

append_field_value(ary, val)

Source

# File lib/net/http/header.rb, line 285defappend_field_value(ary,val)casevalwhenEnumerableval.each{|x|append_field_value(ary,x)}elseval =val.to_sif/[\r\n]/n.match?(val.b)raiseArgumentError,'header field value cannot include CR/LF'endary.pushvalendend

basic_encode(account, password)

Source

# File lib/net/http/header.rb, line 960defbasic_encode(account,password)'Basic '+ ["#{account}:#{password}"].pack('m0')end

capitalize(name)

Source

# File lib/net/http/header.rb, line 493defcapitalize(name)name.to_s.split('-'.freeze).map {|s|s.capitalize }.join('-'.freeze)end

set_field(key, val)

Source

# File lib/net/http/header.rb, line 270defset_field(key,val)casevalwhenEnumerableary = []append_field_value(ary,val)@header[key.downcase.to_s] =aryelseval =val.to_s# for compatibility use to_s instead of to_strifval.b.count("\r\n")>0raiseArgumentError,'header field value cannot include CR/LF'end@header[key.downcase.to_s] = [val]endend

Movatterモバイル変換

module Net::HTTPHeader

Request and Response Fields¶↑

About the Examples¶↑

Fields¶↑

Field Keys¶↑

Field Values¶↑

Convenience Methods¶↑

Setters¶↑

Form Setters¶↑

Getters¶↑

Queries¶↑

Iterators¶↑