class Rack::Response - rack-1.6.4 Documentation

# 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 (a OK response containing HTML).

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
TRANSFER_ENCODING

### 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 25
    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

### Public Instance Methods

[](key) click to toggle source

    # File lib/rack/response.rb, line 52
    def [](key)
      header[key]
    end

[]=(key, value) click to toggle source

    # File lib/rack/response.rb, line 56
    def []=(key, value)
      header[key] = value
    end

close() click to toggle source

    # File lib/rack/response.rb, line 107
    def close
      body.close if body.respond_to?(:close)
    end

delete_cookie(key, value={}) click to toggle source

    # File lib/rack/response.rb, line 64
    def delete_cookie(key, value={})
      Utils.delete_cookie_header!(header, key, value)
    end

each(&callback) click to toggle source

    # File lib/rack/response.rb, line 88
    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 111
    def empty?
      @block == nil && @body.empty?
    end

finish(&block) click to toggle source

    # File lib/rack/response.rb, line 73
    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

Also aliased as: to_a, to_ary
redirect(target, status=302) click to toggle source

    # File lib/rack/response.rb, line 68
    def redirect(target, status=302)
      self.status = status
      self["Location"] = target
    end

set_cookie(key, value) click to toggle source

    # File lib/rack/response.rb, line 60
    def set_cookie(key, value)
      Utils.set_cookie_header!(header, key, value)
    end

to_a(&block)
Alias for: finish
to_ary(&block)
Alias for: finish
write(str) click to toggle source

Append to body and update Content-Length.

NOTE: Do not mix write and direct body access!

    # File lib/rack/response.rb, line 98
    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