package ezcurl

  1. Overview
  2. Docs
On This Page
  1. Synchronous API
Friendly wrapper around OCurl

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (6)

Authors

  1. S
    Simon Cruanes

Maintainers

  1. S
    simon.cruanes.2007@m4x.org

Sources

ezcurl-0.2.4.tbz
sha256=26eda208be72d746eafbfe47f264850ae619e811b8c3165e7684d7a9295541a1
sha512=841d88cd4e7e6449cf17dc4626533856a13c81f96e81305be4773a0d2e5eba524950cd5280da6ff6390c386823c1bdbe671d946f643d26c2ea600b4b1cd66531

doc/ezcurl/Ezcurl/index.html

Module EzcurlSource

Synchronous API

include module type of struct include Ezcurl_core end
Sourcemodule Config = Ezcurl_core.Config

Configuration for the client.

Sourcetype t = Curl.t

A client, i.e. a cURL instance.

Sourceval make : ?set_opts:(t -> unit) -> unit -> t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

Sourceval delete : t -> unit

Delete the client. It cannot be used anymore.

Sourceval with_client : ?set_opts:(t -> unit) -> (t -> 'a) -> 'a

Make a temporary client, call the function with it, then cleanup.

Sourcetype response_info = Ezcurl_core.response_info = {
  1. ri_response_time : float;
    (*

    Total time (in seconds) for the request/response pair. See Curl.get_totaltime.

    *)
  2. ri_redirect_count : int;
    (*

    Number of redirects cURL followed. See Curl.get_redirectcount.

    *)
}

Metadata about a response from the server.

Sourceval pp_response_info : Format.formatter -> response_info -> unit
Sourceval string_of_response_info : response_info -> string
Sourcetype response = Ezcurl_core.response = {
  1. code : int;
    (*

    Response code. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

    *)
  2. headers : (string * string) list;
    (*

    Response headers

    *)
  3. body : string;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

Sourceval pp_response : Format.formatter -> response -> unit
Sourceval string_of_response : response -> string
Sourcetype meth = Ezcurl_core.meth =
  1. | GET
  2. | POST of Curl.curlHTTPPost list
  3. | PUT
  4. | DELETE
  5. | HEAD
  6. | CONNECT
  7. | OPTIONS
  8. | TRACE
  9. | PATCH

The HTTP method to use

Sourceval pp_meth : Format.formatter -> meth -> unit
Sourceval string_of_meth : meth -> string
Sourcemodule type IO = Ezcurl_core.IO
Sourcemodule type S = Ezcurl_core.S
include sig ... end
Sourcetype 'a io = 'a
Sourceval http : ?tries:int -> ?client:Ezcurl_core.t -> ?config:Ezcurl_core.Config.t -> ?range:string -> ?content:[ `String of string | `Write of bytes -> int -> int ] -> ?headers:(string * string) list -> url:string -> meth:Ezcurl_core.meth -> unit -> (Ezcurl_core.response, Curl.curlCode * string) result io
Sourceval get : ?tries:int -> ?client:Ezcurl_core.t -> ?config:Ezcurl_core.Config.t -> ?range:string -> ?headers:(string * string) list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) result io
Sourceval put : ?tries:int -> ?client:Ezcurl_core.t -> ?config:Ezcurl_core.Config.t -> ?headers:(string * string) list -> url:string -> content:[ `String of string | `Write of bytes -> int -> int ] -> unit -> (Ezcurl_core.response, Curl.curlCode * string) result io
Sourceval post : ?tries:int -> ?client:Ezcurl_core.t -> ?config:Ezcurl_core.Config.t -> ?headers:(string * string) list -> ?content:[ `String of string | `Write of bytes -> int -> int ] -> params:Curl.curlHTTPPost list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) result io