pub struct TinyHttpRequest { /* fields omitted */ }
Represents an HTTP request made by a client.
A Request
object is what is produced by the server, and is your what
your code must analyse and answer.
This object implements the Send
trait, therefore you can dispatch your requests to
worker threads.
If a client sends multiple requests in a row (without waiting for the response), then you will
get multiple Request
objects simultaneously. This is called requests pipelining.
Tiny-http automatically reorders the responses so that you don't need to worry about the order
in which you call respond
or into_writer
.
This mechanic is disabled if:
- The body of a request is large enough (handling requires pipelining requires storing the
body of the request in a buffer ; if the body is too big, tiny-http will avoid doing that)
- A request sends a
Expect: 100-continue
header (which means that the client waits to
know whether its body will be processed before sending it)
- A request sends a
Connection: close
header or Connection: upgrade
header (used for
websockets), which indicates that this is the last request that will be received on this
connection
If a Request
object is destroyed without into_writer
or respond
being called,
an empty response with a 500 status code (internal server error) will automatically be
sent back to the client.
This means that if your code fails during the handling of a request, this "internal server
error" response will automatically be sent during the stack unwinding.
Returns true if the request was made through HTTPS.
Returns the method requested by the client (eg. GET
, POST
, etc.).
Returns the resource requested by the client.
Returns a list of all headers sent by the client.
Returns the HTTP version of the request.
Returns the length of the body in bytes.
Returns None
if the length is unknown.
Returns the address of the client that sent this request.
Note that this is gathered from the socket. If you receive the request from a proxy,
this function will return the address of the proxy and not the address of the actual
user.
Sends a response with a Connection: upgrade
header, then turns the Request
into a Stream
.
The main purpose of this function is to support websockets.
If you detect that the request wants to use some kind of protocol upgrade, you can
call this function to obtain full control of the socket stream.
If you call this on a non-websocket request, tiny-http will wait until this Stream
object
is destroyed before continuing to read or write on the socket. Therefore you should always
destroy it as soon as possible.
Allows to read the body of the request.
let mut request = server.recv().unwrap();
if get_content_type(&request) == "application/json" {
let mut content = String::new();
request.as_reader().read_to_string(&mut content).unwrap();
let json: Json = content.parse().unwrap();
}
If the client sent a Expect: 100-continue
header with the request, calling this
function will send back a 100 Continue
response.
Turns the Request
into a writer.
The writer has a raw access to the stream to the user.
This function is useful for things like CGI.
Note that the destruction of the Writer
object may trigger
some events. For exemple if a client has sent multiple requests and the requests
have been processed in parallel, the destruction of a writer will trigger
the writing of the next response.
Therefore you should always destroy the Writer
as soon as possible.
Sends a response to this request.
Executes the destructor for this type. Read more
Formats the value using the given formatter. Read more
type Body = &'r mut dyn Read
The body of this request.
Get the boundary string of this request if it is a POST request with the Content-Type
header set to multipart/form-data
. Read more
Return the request body for reading.
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
impl<T> Typeable for T where T: Any, | |
Get the TypeId
of this object.
impl<T> DebugAny for T where T: Any + Debug, | |
impl<T> UnsafeAny for T where T: Any, | |