Class: Rack::RewindableInput

Inherits:

Object

• Object
• Rack::RewindableInput

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

• #close ⇒ Object

  Closes this RewindableInput object without closing the originally wrapped IO oject.

• #each(&block) ⇒ Object
• #gets ⇒ Object
• #initialize(io) ⇒ RewindableInput constructor

  A new instance of RewindableInput.

• #read(*args) ⇒ Object
• #rewind ⇒ Object

Constructor Details

#initialize(io) ⇒ RewindableInput

Returns a new instance of RewindableInput.

# File 'lib/rack/rewindable_input.rb', line 16

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 oject. Cleans up any temporary resources that this RewindableInput has created.

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

# File 'lib/rack/rewindable_input.rb', line 47

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

#each(&block) ⇒ Object

# File 'lib/rack/rewindable_input.rb', line 32

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

#gets ⇒ Object

# File 'lib/rack/rewindable_input.rb', line 22

def gets
  make_rewindable unless @rewindable_io
  @rewindable_io.gets
end

#read(*args) ⇒ Object

# File 'lib/rack/rewindable_input.rb', line 27

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

#rewind ⇒ Object

# File 'lib/rack/rewindable_input.rb', line 37

def rewind
  make_rewindable unless @rewindable_io
  @rewindable_io.rewind
end