Module
pooka/httpc
src/pooka/httpc.pookaAn HTTP client, using the one that comes with Erlang.
import httpc
main() {
match httpc.get("https://example.org/") {
Ok(reply) -> echo reply.status
Error(problem) -> echo httpc.describe(problem)
}
}
Requests and responses are the ones from pooka/http, the same a server
receives. TLS certificates are checked against the operating
system's trusted authorities, and connections are kept open and reused.
API reference
class OptionsHow a request is sent. Start with defaults, then adjust.
let timeout: IntIntlet connect_timeout: IntIntlet follow_redirects: BoolBoollet verify_tls: BoolBoolnew(
timeout: Int,
connect_timeout: Int,
follow_redirects: Bool,
verify_tls: Bool
)fn(Int, Int, Bool, Bool) -> pooka/httpc.Optionswith_timeout(milliseconds: Int) -> Optionsfn(Int) -> pooka/httpc.OptionsHow long to wait for the whole response, in milliseconds.
with_connect_timeout(milliseconds: Int) -> Optionsfn(Int) -> pooka/httpc.OptionsHow long to wait for the connection, in milliseconds.
following_redirects() -> Optionsfn() -> pooka/httpc.OptionsFollow redirects to their end, instead of returning the redirect.
without_tls_verification() -> Optionsfn() -> pooka/httpc.OptionsAccept any certificate. Only for servers you control, such as a local one with a self-signed certificate.
defaults() -> Optionsfn() -> pooka/httpc.OptionsThirty seconds for a response, ten to connect, no redirects followed, and certificates checked.
class HttpcErrorWhy a request got no response.
class BadUrl(reason: String) is HttpcErrorThe URL could not be read.
reason: StringStringfn(String) -> pooka/httpc.BadUrlclass CouldNotConnect(reason: String) is HttpcErrorNo connection: the host is unknown, refused, or the certificate is not trusted.
reason: StringStringfn(String) -> pooka/httpc.CouldNotConnectclass TimedOut is HttpcErrorThe connection or the response took too long.
class Unsupported(reason: String) is HttpcErrorA method this client cannot send.
reason: StringStringfn(String) -> pooka/httpc.Unsupportedclass Failed(reason: String) is HttpcErrorAnything else that went wrong on the way.
reason: StringStringfn(String) -> pooka/httpc.Faileddescribe(problem: HttpcError) -> Stringfn(pooka/httpc.HttpcError) -> StringA sentence about what went wrong.
send(request: Request) -> Result(Response, HttpcError)fn($package/pooka_http/pooka/http.Request) -> Result($package/pooka_http/pooka/http.Response, pooka/httpc.HttpcError)Send a request, and wait for the response. Any status counts as a
response, 404 and 500 included; check reply.status.
send_with(request: Request, options: Options) -> Result(Response, HttpcError)fn($package/pooka_http/pooka/http.Request, pooka/httpc.Options) -> Result($package/pooka_http/pooka/http.Response, pooka/httpc.HttpcError)Send a request with your own options.
get(url: String) -> Result(Response, HttpcError)fn(String) -> Result($package/pooka_http/pooka/http.Response, pooka/httpc.HttpcError)GET a URL.
post_text(url: String, body: String) -> Result(Response, HttpcError)fn(String, String) -> Result($package/pooka_http/pooka/http.Response, pooka/httpc.HttpcError)POST text to a URL.
post_json(url: String, body: String) -> Result(Response, HttpcError)fn(String, String) -> Result($package/pooka_http/pooka/http.Response, pooka/httpc.HttpcError)POST JSON text, already encoded, to a URL.