Struct mio_httpc::CallBuilder [−][src]
pub struct CallBuilder { /* fields omitted */ }
Expand description
Used to start a call and get a Call for it.
Implementations
CallBuilder constructs a call. It is finished after calling: exec, simple_call, call or websocket.
Some headers are set automatically unless set explicitly: user-agent, connection, host, auth, content-length
If you’re only executing a one-off call you should set connection header to close as default is keep-alive.
If you do not set body, but do set content-length, it will wait for send body to be provided through Httpc::call_send. You must use a streaming interface in this case and can not use SimpleCall.
Start a GET request.
Start a POST request.
Start a PUT request.
Start a DELETE request.
Start an OPTIONS request.
Start a HEAD request.
Set method: “GET”, “POST”, “PUT”, “OPTIONS”, “DELETE” or “HEAD”
Default: http
Use https for call. Shorthand for set_https(true)
Set host where to connect to. It can be a domain or IP address.
Specifically set mio token IDs for call. Must be outside of token range specified im Httpc::new Two tokens are required becase when initiating connection both ipv4 and ipv6 connections are attempted. First one to connect wins and the other one is closed.
Use http authentication with username and password.
Set full path. No percent encoding is done. Will fail later if it contains invalid characters.
Add a single segment of path. Parts are delimited by / which are added automatically. Any path unsafe characters are percent encoded. If part contains /, it will be percent encoded!
Add a key-value pair to query. Any url unsafe characters are percent encoded.
Add multiple key-value pars in one go.
Set full URL. If not valid it will return error. Be mindful of characters that need to be percent encoded. Using https, path_segm, query and auth functions to construct URL is much safer as those encode data automatically.
Set HTTP header.
Execute directly. This will block until completion!
Consume and execute HTTP call. Returns SimpleCall interface. CallBuilder is invalid after this call and will panic if used again.
Consume and execute HTTP call. Return low level streaming call interface. CallBuilder is invalid after this call and will panic if used again.
Consume and start a WebSocket CallBuilder is invalid after this call and will panic if used again.
Default 10MB.
This will limit how big the internal Vec
For WebSockets this will also be a received fragment size limit!
Default: 100ms
Starting point of dns packet resends if nothing received. Every next resend timeout is 2x the previous one but stops at 1s. Make sure to call Httpc::timeout! So for 100ms: 100ms, 200ms, 400ms, 800ms, 1000ms, 1000ms…
Default true.
Configurable because it entails copying the data stream.
Default 128K
Max size of chunk in a chunked transfer.
Default 60s
Maximum amount of time a call should last. Make sure to call Httpc::timeout!
Default 4.
How many redirects to follow. 0 to disable following redirects.
Default true.
Tell server to gzip response and unzip transparently before returning body to client.
Default secure.
Turn off domain verification over ssl. This should only be used when testing as you are throwing away a big part of ssl security.
Use digest authentication. If you know server is using digest auth you REALLY should set it to true. If server is using basic authentication and you set digest_auth to true, mio_httpc will retry with basic. If not set, basic auth is assumed which is very insecure.
Trait Implementations
Returns the “default value” for a type. Read more