httpx/sig/response.rbs
HoneyryderChuck 9465a077b1 Add Response#peer_address and ErrorResponse#peer_address
responses can now expose the IP address used to connect to the peer
server to fetch the response from.
2023-10-30 09:52:30 +00:00

97 lines
1.8 KiB
Plaintext

module HTTPX
interface _Response
def finished?: () -> bool
def raise_for_status: () -> self
def error: () -> StandardError?
end
class Response
extend Forwardable
include Callbacks
include _Response
include _ToS
include _Reader
attr_reader status: Integer
attr_reader headers: Headers
attr_reader body: Body
attr_reader version: String
@options: Options
@request: Request
@content_type: ContentType
def copy_to: (_ToPath | _Writer destination) -> void
def close: () -> void
def uri: () -> URI::Generic
def peer_address: () -> ipaddr?
def merge_headers: (_Each[[String, headers_value]]) -> void
def bodyless?: () -> bool
def content_type: () -> ContentType
def complete?: () -> bool
def json: (?json_options opts) -> untyped
def form: () -> Hash[String, untyped]
def initialize: (Request request, String | Integer status, String version, headers?) -> void
private
def decode:(Transcoder::_Decode transcoder, ?untyped options) -> untyped
end
class ContentType
MIME_TYPE_RE: Regexp
CHARSET_RE: Regexp
@header_value: String?
@mime_type: String?
@charset: String?
def mime_type: () -> String?
def charset: () -> String?
private
def initialize: (String? header_value) -> void
end
class ErrorResponse
include _Response
include Loggable
extend Forwardable
@options: Options
@error: Exception
attr_reader request: Request
attr_reader response: Response?
def status: () -> (Integer | _ToS)
def uri: () -> URI::Generic
def peer_address: () -> ipaddr?
def close: () -> void
private
def initialize: (Request, Exception, options) -> untyped
end
type response = Response | ErrorResponse
end