package ezcurl

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Synchronous API

package ezcurl

ezcurl
- Ezcurl
ezcurl.core
- Ezcurl_core
  - Config
  - IO
  - Make
    
    IO
  - S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Synchronous API

include module type of struct include Ezcurl_core end

module Config = Ezcurl_core.Config

Configuration for the client.

type t = Curl.t

A client, i.e. a cURL instance.

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

Create a new client.

parameter set_opts
called before returning the client, to set options

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

type response_info = Ezcurl_core.response_info = {

ri_response_time : float;
(*
Total time (in seconds) for the request/response pair. See Curl.get_totaltime.
*)
ri_redirect_count : int;
(*
Number of redirects cURL followed. See Curl.get_redirectcount.
*)

}

Metadata about a response from the server.

val pp_response_info : Format.formatter -> response_info -> unit

val string_of_response_info : response_info -> string

type response = Ezcurl_core.response = {

code : int;
(*
Response code. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
*)
headers : (string * string) list;
(*
Response headers
*)
body : string;
(*
Response body, or ""
*)
info : response_info;
(*
Information about the response
*)

}

Response for a given request.

val pp_response : Format.formatter -> response -> unit

val string_of_response : response -> string

type meth = Ezcurl_core.meth =

| GET
| POST of Curl.curlHTTPPost list
| PUT
| DELETE
| HEAD
| CONNECT
| OPTIONS
| TRACE
| PATCH

The HTTP method to use

val pp_meth : Format.formatter -> meth -> unit

val string_of_meth : meth -> string

module type IO = Ezcurl_core.IO

module type S = Ezcurl_core.S

module Make = Ezcurl_core.Make

include sig ... end

type 'a io = 'a

val 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

val 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

val 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

val 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