diff --git a/lib/net/http/header.rb b/lib/net/http/header.rb
index 6d14ce4b..d7e53a5f 100644
--- a/lib/net/http/header.rb
+++ b/lib/net/http/header.rb
@@ -145,7 +145,7 @@
# - #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'.
-# - #range=: Sets the value for field +'Range'+.
+# - #set_range: Sets the value for field 'Range'.
#
# === Queries
#
@@ -460,8 +460,16 @@ def capitalize(name)
end
private :capitalize
- # Returns an Array of Range objects which represent the Range:
- # HTTP header field, or +nil+ if there is no such header.
+ # Returns an array of Range objects that represent
+ # the value of field 'Range',
+ # or +nil+ if there is no such field;
+ # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
+ #
+ # req['Range'] = 'bytes=0-99,200-299,400-499'
+ # req.range # => [0..99, 200..299, 400..499]
+ # req.delete('Range')
+ # req.range # # => nil
+ #
def range
return nil unless @header['range']
@@ -504,14 +512,30 @@ def range
result
end
- # Sets the HTTP Range: header.
- # Accepts either a Range object as a single argument,
- # or a beginning index and a length from that index.
- # Example:
+ # :call-seq:
+ # set_range(length) -> length
+ # set_range(offset, length) -> range
+ # set_range(begin..length) -> range
+ #
+ # Sets the value for field 'Range';
+ # see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
+ #
+ # With argument +length+:
+ #
+ # req.set_range(100) # => 100
+ # req['Range'] # => "bytes=0-99"
+ #
+ # With arguments +offset+ and +length+:
+ #
+ # req.set_range(100, 100) # => 100...200
+ # req['Range'] # => "bytes=100-199"
+ #
+ # With argument +range+:
#
- # req.range = (0..1023)
- # req.set_range 0, 1023
+ # req.set_range(100..199) # => 100..199
+ # req['Range'] # => "bytes=100-199"
#
+ # Net::HTTPHeader#range= is an alias for Net::HTTPHeader#set_range.
def set_range(r, e = nil)
unless r
@header.delete 'range'