Class: Falcon::Adapters::Input

Inherits:
Object
  • Object
show all
Defined in:
lib/falcon/adapters/input.rb

Overview

The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body) ⇒ Input

Returns a new instance of Input.



30
31
32
33
34
35
36
 
# File 'lib/falcon/adapters/input.rb', line 30

def initialize(body)
	@body = body
	
	# Will hold remaining data in `#read`.
	@buffer = nil
	@finished = @body.nil?
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



38
39
40
 
# File 'lib/falcon/adapters/input.rb', line 38

def body
  @body
end

Instance Method Details

#close ⇒ Object

close must never be called on the input stream. huh?



113
114
115
 
# File 'lib/falcon/adapters/input.rb', line 113

def close
	@body&.close
end

#each(&block) ⇒ Object

each must be called without arguments and only yield Strings.



41
42
43
44
45
46
47
 
# File 'lib/falcon/adapters/input.rb', line 41

def each(&block)
	return to_enum unless block_given?
	
	while chunk = gets
		yield chunk
	end
end

#eof? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/falcon/adapters/input.rb', line 96

def eof?
	@finished and @buffer.nil?
end

#gets ⇒ String?

gets must be called without arguments and return a string, or nil on EOF.

Returns:

  • (String, nil) —

    The next chunk from the body.



102
103
104
105
106
107
108
109
110
 
# File 'lib/falcon/adapters/input.rb', line 102

def gets
	if @buffer.nil?
		return read_next
	else
		buffer = @buffer
		@buffer = nil
		return buffer
	end
end

#read(length = nil, buffer = nil) ⇒ Object

read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.

Parameters:

  • length (Integer) (defaults to: nil) —

    the amount of data to read

  • buffer (String) (defaults to: nil) —

    the buffer which will receive the data

Returns:

  • a buffer containing the data



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/falcon/adapters/input.rb', line 68

def read(length = nil, buffer = nil)
	buffer ||= Async::IO::Buffer.new
	buffer.clear
	
	until buffer.bytesize == length
		@buffer = read_next if @buffer.nil?
		break if @buffer.nil?
		
		remaining_length = length - buffer.bytesize if length
		
		if remaining_length && remaining_length < @buffer.bytesize
			# We know that we are not going to reuse the original buffer.
			# But byteslice will generate a hidden copy. So let's freeze it first:
			@buffer.freeze
			
			buffer << @buffer.byteslice(0, remaining_length)
			@buffer = @buffer.byteslice(remaining_length, @buffer.bytesize)
		else
			buffer << @buffer
			@buffer = nil
		end
	end
	
	return nil if buffer.empty? && length && length > 0
	
	return buffer
end

#rewind ⇒ Boolean

rewind must be called without arguments. It rewinds the input stream back to the beginning. It must not raise Errno::ESPIPE: that is, it may not be a pipe or a socket. Therefore, handler developers must buffer the input data into some rewindable object if the underlying input stream is not rewindable.

Returns:

  • (Boolean) —

    whether the body could be rewound.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/falcon/adapters/input.rb', line 51

def rewind
	if @body and @body.respond_to? :rewind
		# If the body is not rewindable, this will fail.
		@body.rewind
		@buffer = nil
		@finished = false
		
		return true
	end
	
	return false
end