class HTTP::Request

Overview

An HTTP request.

It serves both to perform requests by an HTTP::Client and to represent requests received by an HTTP::Server.

A request always holds an IO as a body. When creating a request with a String or Bytes its body will be a IO::Memory wrapping these, and the Content-Length header will be set appropriately.

Defined in:

http/request.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other)
==
, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, class class, dup dup, hash(hasher)
hash
hash
, inspect(io : IO)
inspect
inspect
, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s
to_s(io : IO)
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io) : self from_yaml

Constructor Detail

def self.new(method : String, resource : String, headers : Headers? = nil, body : String | Bytes | IO | Nil = nil, version = "HTTP/1.1") #

[View source]

Class Method Detail

def self.from_io(io) #

Returns a HTTP::Request instance if successfully parsed, nil on EOF or BadRequest otherwise.


[View source]

Instance Method Detail

def body : IO? #

[View source]
def body=(body : Nil) #

[View source]
def body=(body : IO) #

[View source]
def body=(body : Bytes) #

[View source]
def body=(body : String) #

[View source]
def content_length #

[View source]
def content_length=(length : Int) #

[View source]
def cookies #

Returns a convenience wrapper around querying and setting cookie related headers, see HTTP::Cookies.


[View source]
def headers : Headers #

[View source]
def headers=(headers : Headers) #

[View source]
def host #

Return request host from headers.


[View source]
def host_with_port #

Return request host with port from headers.


[View source]
def ignore_body? #

[View source]
def keep_alive? #

[View source]
def method : String #

[View source]
def method=(method : String) #

[View source]
def path #

Lazily parses and return the request's path component.


[View source]
def path=(path) #

Sets request's path component.


[View source]
def query #

Lazily parses and returns the request's query component.


[View source]
def query=(value) #

Sets request's query component.


[View source]
def query_params #

Returns a convenience wrapper around querying and setting query params, see HTTP::Params.


[View source]
def resource #

[View source]
def to_io(io) #

[View source]
def version : String #

[View source]
def version=(version : String) #

[View source]