Class: Rack::Response
Overview
Rack::Response provides a convenient interface to create a Rack response.
It allows setting of headers and cookies, and provides useful defaults (a OK response containing HTML).
You can use Response#write to iteratively generate your response, but note
that this is buffered by Rack::Response until you call finish
.
finish
however can take a block inside which calls to
write
are synchronous with the Rack response.
Your application's call
should end returning Response#finish.
Direct Known Subclasses
Defined Under Namespace
Modules: Helpers
Instance Attribute Summary (collapse)
-
- (void) body
Returns the value of attribute body.
-
- (void) header
(also: #headers)
readonly
Returns the value of attribute header.
-
- (void) headers
included
from Helpers
readonly
Headers.
-
- (void) length
Returns the value of attribute length.
-
- (void) original_headers
included
from Helpers
readonly
Headers.
-
- (void) status
Returns the value of attribute status.
Instance Method Summary (collapse)
- - (void) [](key)
- - (void) []=(key, value)
- - (Boolean) bad_request? included from Helpers
- - (Boolean) client_error? included from Helpers
- - (void) close
- - (void) content_length included from Helpers
- - (void) content_type included from Helpers
- - (void) delete_cookie(key, value = {})
- - (void) each(&callback)
- - (Boolean) empty?
- - (void) finish(&block) (also: #to_a, #to_ary)
- - (Boolean) forbidden? included from Helpers
- - (Boolean) include?(header) included from Helpers
- - (Boolean) informational? included from Helpers
-
- (Response) initialize(body = [], status = 200, header = {}) {|_self| ... }
constructor
A new instance of Response.
- - (Boolean) invalid? included from Helpers
- - (void) location included from Helpers
- - (Boolean) method_not_allowed? included from Helpers
- - (Boolean) not_found? included from Helpers
- - (Boolean) ok? included from Helpers
- - (void) redirect(target, status = 302)
- - (Boolean) redirect? included from Helpers
- - (Boolean) redirection? included from Helpers
- - (Boolean) server_error? included from Helpers
- - (void) set_cookie(key, value)
- - (Boolean) successful? included from Helpers
- - (Boolean) unprocessable? included from Helpers
-
- (void) write(str)
Append to body and update Content-Length.
Constructor Details
- (Response) initialize(body = [], status = 200, header = {}) {|_self| ... }
Returns a new instance of Response
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'rack/rack/response.rb', line 22 def initialize(body=[], status=200, header={}) @status = status.to_i @header = Utils::HeaderHash.new.merge(header) @chunked = "chunked" == @header['Transfer-Encoding'] @writer = lambda { |x| @body << x } @block = nil @length = 0 @body = [] if body.respond_to? :to_str write body.to_str elsif body.respond_to?(:each) body.each { |part| write part.to_s } else raise TypeError, "stringable or iterable required" end yield self if block_given? end |
Instance Attribute Details
- (void) body
Returns the value of attribute body
47 48 49 |
# File 'rack/rack/response.rb', line 47 def body @body end |
- (void) header (readonly) Also known as: headers
Returns the value of attribute header
46 47 48 |
# File 'rack/rack/response.rb', line 46 def header @header end |
- (void) headers (readonly) Originally defined in module Helpers
Headers
- (void) length
Returns the value of attribute length
20 21 22 |
# File 'rack/rack/response.rb', line 20 def length @length end |
- (void) original_headers (readonly) Originally defined in module Helpers
Headers
- (void) status
Returns the value of attribute status
47 48 49 |
# File 'rack/rack/response.rb', line 47 def status @status end |
Instance Method Details
- (void) [](key)
49 50 51 |
# File 'rack/rack/response.rb', line 49 def [](key) header[key] end |
- (void) []=(key, value)
53 54 55 |
# File 'rack/rack/response.rb', line 53 def []=(key, value) header[key] = value end |
- (Boolean) bad_request? Originally defined in module Helpers
- (Boolean) client_error? Originally defined in module Helpers
- (void) close
104 105 106 |
# File 'rack/rack/response.rb', line 104 def close body.close if body.respond_to?(:close) end |
- (void) content_length Originally defined in module Helpers
- (void) content_type Originally defined in module Helpers
- (void) delete_cookie(key, value = {})
61 62 63 |
# File 'rack/rack/response.rb', line 61 def (key, value={}) Utils.(header, key, value) end |
- (void) each(&callback)
85 86 87 88 89 |
# File 'rack/rack/response.rb', line 85 def each(&callback) @body.each(&callback) @writer = callback @block.call(self) if @block end |
- (Boolean) empty?
108 109 110 |
# File 'rack/rack/response.rb', line 108 def empty? @block == nil && @body.empty? end |
- (void) finish(&block) Also known as: to_a, to_ary
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'rack/rack/response.rb', line 70 def finish(&block) @block = block if [204, 205, 304].include?(status.to_i) header.delete "Content-Type" header.delete "Content-Length" close [status.to_i, header, []] else [status.to_i, header, BodyProxy.new(self){}] end end |
- (Boolean) forbidden? Originally defined in module Helpers
- (Boolean) include?(header) Originally defined in module Helpers
- (Boolean) informational? Originally defined in module Helpers
- (Boolean) invalid? Originally defined in module Helpers
- (void) location Originally defined in module Helpers
- (Boolean) method_not_allowed? Originally defined in module Helpers
- (Boolean) not_found? Originally defined in module Helpers
- (Boolean) ok? Originally defined in module Helpers
- (void) redirect(target, status = 302)
65 66 67 68 |
# File 'rack/rack/response.rb', line 65 def redirect(target, status=302) self.status = status self["Location"] = target end |
- (Boolean) redirect? Originally defined in module Helpers
- (Boolean) redirection? Originally defined in module Helpers
- (Boolean) server_error? Originally defined in module Helpers
- (void) set_cookie(key, value)
57 58 59 |
# File 'rack/rack/response.rb', line 57 def (key, value) Utils.(header, key, value) end |
- (Boolean) successful? Originally defined in module Helpers
- (Boolean) unprocessable? Originally defined in module Helpers
- (void) write(str)
Append to body and update Content-Length.
NOTE: Do not mix #write and direct #body access!
95 96 97 98 99 100 101 102 |
# File 'rack/rack/response.rb', line 95 def write(str) s = str.to_s @length += Rack::Utils.bytesize(s) unless @chunked @writer.call s header["Content-Length"] = @length.to_s unless @chunked str end |