1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
# frozen_string_literal: true
# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
require 'async/io/buffer'
module Protocol
module HTTP
module Body
# A generic base class for wrapping body instances. Typically you'd override `#read`.
# The implementation assumes a sequential unbuffered stream of data.
# def each -> yield(String | nil)
# def read -> String | nil
# def join -> String
# def finish -> buffer the stream and close it.
# def close(error = nil) -> close the stream immediately.
# end
class Readable
# The consumer can call stop to signal that the stream output has terminated.
def close(error = nil)
end
# Will read return any data?
def empty?
false
end
# Whether calling read will block.
# We prefer pessimistic implementation, and thus default to `false`.
# @return [Boolean]
def ready?
false
end
def length
nil
end
# Read the next available chunk.
def read
nil
end
# Should the internal mechanism prefer to use {call}?
# @returns [Boolean]
def stream?
false
end
# Write the body to the given stream.
def call(stream)
while chunk = self.read
stream.write(chunk)
end
ensure
stream.close
end
# Read all remaining chunks into a buffered body and close the underlying input.
def finish
# Internally, this invokes `self.each` which then invokes `self.close`.
Buffered.for(self)
end
# Enumerate all chunks until finished, then invoke `#close`.
def each
while chunk = self.read
yield chunk
end
ensure
self.close($!)
end
# Read all remaining chunks into a single binary string using `#each`.
def join
buffer = String.new.force_encoding(Encoding::BINARY)
self.each do |chunk|
buffer << chunk
end
if buffer.empty?
return nil
else
return buffer
end
end
end
end
end
end
|