class Rack::Response
Rack::Response provides a convenient interface to create a Rack response.
It allows setting of headers and cookies, and provides useful defaults (an OK response with empty headers and body).
You can use #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 #finish.
Constants
- CHUNKED
Attributes
body[RW]
header[R]
headers[R]
length[RW]
status[RW]
Public Class Methods
new(body=[], status=200, header={}) { |self| ... }
click to toggle source
# File lib/rack/response.rb, line 28 def initialize(body=[], status=200, header={}) @status = status.to_i @header = Utils::HeaderHash.new.merge(header) @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
Public Instance Methods
chunked?()
click to toggle source
# File lib/rack/response.rb, line 56 def chunked? CHUNKED == get_header(TRANSFER_ENCODING) end
close()
click to toggle source
# File lib/rack/response.rb, line 94 def close body.close if body.respond_to?(:close) end
delete_header(key)
click to toggle source
# File lib/rack/response.rb, line 105 def delete_header(key); headers.delete key; end
each(&callback)
click to toggle source
# File lib/rack/response.rb, line 75 def each(&callback) @body.each(&callback) @writer = callback @block.call(self) if @block end
empty?()
click to toggle source
# File lib/rack/response.rb, line 98 def empty? @block == nil && @body.empty? end
finish(&block)
click to toggle source
# File lib/rack/response.rb, line 60 def finish(&block) @block = block if [204, 205, 304].include?(status.to_i) delete_header CONTENT_TYPE delete_header CONTENT_LENGTH close [status.to_i, header, []] else [status.to_i, header, BodyProxy.new(self){}] end end
get_header(key)
click to toggle source
# File lib/rack/response.rb, line 103 def get_header(key); headers[key]; end
Also aliased as: []
has_header?(key)
click to toggle source
# File lib/rack/response.rb, line 102 def has_header?(key); headers.key? key; end
redirect(target, status=302)
click to toggle source
# File lib/rack/response.rb, line 51 def redirect(target, status=302) self.status = status self.location = target end
set_header(key, v)
click to toggle source
# File lib/rack/response.rb, line 104 def set_header(key, v); headers[key] = v; end
Also aliased as: []=
write(str)
click to toggle source