class HTTP::Client::Response
Defined in:
http/client/response.crConstructors
- .new(status : HTTP::Status, body : String | Nil = nil, headers : Headers = Headers.new, status_message = nil, version : String = "HTTP/1.1", body_io : IO | Nil = nil)
- .new(status_code : Int32, body : String | Nil = nil, headers : Headers = Headers.new, status_message = nil, version = "HTTP/1.1", body_io = nil)
Class Method Summary
- .from_io(io, ignore_body = false, decompress = true)
- .from_io(io, ignore_body = false, decompress = true, &)
-
.from_io?(io, ignore_body = false, decompress = true) : self | Nil
Parses an
HTTP::Client::Response
from the givenIO
. -
.from_io?(io, ignore_body = false, decompress = true, &)
Parses an
HTTP::Client::Response
from the givenIO
and yields it to the block. - .mandatory_body?(status : HTTP::Status) : Bool
- .supports_chunked?(version) : Bool
Instance Method Summary
- #body : String
- #body? : String | Nil
- #body_io : IO
- #body_io? : IO | Nil
- #charset : String | Nil
- #content_type : String | Nil
-
#cookies : HTTP::Cookies
Returns a convenience wrapper around querying and setting cookie related headers, see
HTTP::Cookies
. - #headers : Headers
- #keep_alive? : Bool
- #mime_type : MIME::MediaType | Nil
- #status : HTTP::Status
-
#status_code : Int32
Convenience method to retrieve the HTTP status code.
- #status_message : String | Nil
-
#success? : Bool
Returns
true
if the response status code is between 200 and 299. - #to_io(io)
- #version : String
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new
new,
unsafe_construct(address : Pointer, *args, **opts) : self
unsafe_construct
Class methods inherited from class Reference
pre_initialize(address : Pointer)
pre_initialize
Instance methods inherited from class Object
! : Bool
!,
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Constructor Detail
Class Method Detail
Parses an HTTP::Client::Response
from the given IO
.
Might return nil
if there's no data in the IO
,
which probably means that the connection was closed.
Parses an HTTP::Client::Response
from the given IO
and yields
it to the block. Might yield nil
if there's no data in the IO
,
which probably means that the connection was closed.
Instance Method Detail
Returns a convenience wrapper around querying and setting cookie related
headers, see HTTP::Cookies
.
Returns true
if the response status code is between 200 and 299.