Class: HTTPX::Response::Body

Inherits:
Object
  • Object
show all
Defined in:
lib/httpx/response.rb

Instance Method Summary collapse

Constructor Details

#initialize(response, threshold_size:, window_size: 1 << 14) ⇒ Body

Returns a new instance of Body.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/httpx/response.rb', line 69

def initialize(response, threshold_size:, window_size: 1 << 14)
  @response = response
  @headers = response.headers
  @threshold_size = threshold_size
  @window_size = window_size
  @encoding = response.content_type.charset || Encoding::BINARY
  @length = 0
  @buffer = nil
  @state = :idle
end

Instance Method Details

#==(other) ⇒ Object 



142
143
144
 
# File 'lib/httpx/response.rb', line 142

def ==(other)
  to_s == other.to_s
end

#bytesize ⇒ Object 



91
92
93
 
# File 'lib/httpx/response.rb', line 91

def bytesize
  @length
end

#close ⇒ Object

closes/cleans the buffer, resets everything



133
134
135
136
137
138
139
140
 
# File 'lib/httpx/response.rb', line 133

def close
  return if @state == :idle
  @buffer.close
  @buffer.unlink if @buffer.respond_to?(:unlink)
  @buffer = nil
  @length = 0
  @state = :idle
end

#copy_to(dest) ⇒ Object 



122
123
124
125
126
127
128
129
130
 
# File 'lib/httpx/response.rb', line 122

def copy_to(dest)
  return unless @buffer
  if dest.respond_to?(:path) && @buffer.respond_to?(:path)
    FileUtils.mv(@buffer.path, dest.path)
  else
    @buffer.rewind
    ::IO.copy_stream(@buffer, dest)
  end
end

#each ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/httpx/response.rb', line 95

def each
  return enum_for(__method__) unless block_given?
  begin
    unless @state == :idle
      rewind
      while (chunk = @buffer.read(@window_size))
        yield(chunk)
      end
    end
  ensure
    close
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/httpx/response.rb', line 118

def empty?
  @length.zero?
end

#read(*args) ⇒ Object 



86
87
88
89
 
# File 'lib/httpx/response.rb', line 86

def read(*args)
  return unless @buffer
  @buffer.read(*args)
end

#to_s ⇒ Object Also known as: to_str 



109
110
111
112
113
114
115
 
# File 'lib/httpx/response.rb', line 109

def to_s
  rewind
  return @buffer.read.force_encoding(@encoding) if @buffer
  ""
ensure
  close
end

#write(chunk) ⇒ Object 



80
81
82
83
84
 
# File 'lib/httpx/response.rb', line 80

def write(chunk)
  @length += chunk.bytesize
  transition
  @buffer.write(chunk)
end