Wraps an error which has happened while processing an HTTP Request. It has partial public API parity with HTTPX::Response, so users should rely on it to infer whether the returned response is one or the other.
response = HTTPX.get("https://some-domain/path") #=> response is HTTPX::Response or HTTPX::ErrorResponse response.raise_for_status #=> raises if it wraps an error
Methods
Public Class
Public Instance
Attributes
| error | [R] |
the wrapped exception. |
| request | [R] |
the corresponding |
| response | [R] |
the |
Public Class methods
new(request, error)
[show source]
# File lib/httpx/response.rb 295 def initialize(request, error) 296 @request = request 297 @response = request.response if request.response.is_a?(Response) 298 @error = error 299 @options = request.options 300 @request.log_exception(@error) 301 finish! 302 end
Public Instance methods
<<(data)
buffers lost chunks to error response
[show source]
# File lib/httpx/response.rb 329 def <<(data) 330 return unless @response 331 332 @response << data 333 end
close()
closes the error resources.
[show source]
# File lib/httpx/response.rb 310 def close 311 @response.close if @response 312 end
finish!()
[show source]
# File lib/httpx/response.rb 319 def finish! 320 @request.connection = nil 321 end
finished?()
always true for error responses.
[show source]
# File lib/httpx/response.rb 315 def finished? 316 true 317 end
raise_for_status()
raises the wrapped exception.
[show source]
# File lib/httpx/response.rb 324 def raise_for_status 325 raise @error 326 end
to_s()
returns the exception full message.
[show source]
# File lib/httpx/response.rb 305 def to_s 306 @error.full_message(highlight: false) 307 end