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
|
# frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2019-2025, by Samuel Williams.
require_relative "wrapper"
module Protocol
module HTTP
module Body
# Invokes a callback once the body has completed, either successfully or due to an error.
class Completable < Wrapper
# Wrap a message body with a callback. If the body is empty, the callback is invoked immediately.
#
# @parameter message [Request | Response] the message body.
# @parameter block [Proc] the callback to invoke when the body is closed.
def self.wrap(message, &block)
if body = message&.body and !body.empty?
message.body = self.new(message.body, block)
else
yield
end
end
# Initialize the completable body with a callback.
#
# @parameter body [Readable] the body to wrap.
# @parameter callback [Proc] the callback to invoke when the body is closed.
def initialize(body, callback)
super(body)
@callback = callback
end
# @returns [Boolean] completable bodies are not rewindable.
def rewindable?
false
end
# Rewind the body, is not supported.
def rewind
false
end
# Close the body and invoke the callback. If an error is given, it is passed to the callback.
#
# The calback is only invoked once, and before `super` is invoked.
def close(error = nil)
if @callback
@callback.call(error)
@callback = nil
end
super
end
# Convert the body to a hash suitable for serialization.
#
# @returns [Hash] The body as a hash.
def as_json(...)
super.merge(
callback: @callback&.to_s
)
end
# Inspect the completable body.
#
# @returns [String] a string representation of the completable body.
def inspect
callback_status = @callback ? "callback pending" : "callback completed"
return "#{super} | #<#{self.class} #{callback_status}>"
end
end
end
end
end
|
