Class: Rack::RewindableInput

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/rewindable_input.rb

Overview

Class which can make any IO object rewindable, including non-rewindable ones. It does this by buffering the data into a tempfile, which is rewindable.

rack.input is required to be rewindable, so if your input stream IO is non-rewindable by nature (e.g. a pipe or a socket) then you can wrap it in an object of this class to easily make it rewindable.

Don’t forget to call #close when you’re done. This frees up temporary resources that RewindableInput uses, though it does not close the original IO object.

Instance Method Summary collapse

Constructor Details

#initialize(io) ⇒ RewindableInput

Returns a new instance of RewindableInput.



17
18
19
20
21
 
# File 'lib/rack/rewindable_input.rb', line 17

def initialize(io)
  @io = io
  @rewindable_io = nil
  @unlinked = false
end

Instance Method Details

#close ⇒ Object

Closes this RewindableInput object without closing the originally wrapped IO object. Cleans up any temporary resources that this RewindableInput has created.

This method may be called multiple times. It does nothing on subsequent calls.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rack/rewindable_input.rb', line 48

def close
  if @rewindable_io
    if @unlinked
      @rewindable_io.close
    else
      @rewindable_io.close!
    end
    @rewindable_io = nil
  end
end

#each(&block) ⇒ Object 



33
34
35
36
 
# File 'lib/rack/rewindable_input.rb', line 33

def each(&block)
  make_rewindable unless @rewindable_io
  @rewindable_io.each(&block)
end

#gets ⇒ Object 



23
24
25
26
 
# File 'lib/rack/rewindable_input.rb', line 23

def gets
  make_rewindable unless @rewindable_io
  @rewindable_io.gets
end

#read(*args) ⇒ Object 



28
29
30
31
 
# File 'lib/rack/rewindable_input.rb', line 28

def read(*args)
  make_rewindable unless @rewindable_io
  @rewindable_io.read(*args)
end

#rewind ⇒ Object 



38
39
40
41
 
# File 'lib/rack/rewindable_input.rb', line 38

def rewind
  make_rewindable unless @rewindable_io
  @rewindable_io.rewind
end