From 9d2338c9d2af9decbc3993e5b26a73ec98c8b284 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sat, 14 Sep 2019 12:40:45 -0500 Subject: [PATCH] update dev doc --- dev/ezcurl-lwt/Ezcurl_lwt/index.html | 2 +- dev/ezcurl-lwt/Ezcurl_lwt/module-type-S/index.html | 2 +- dev/ezcurl/Ezcurl/index.html | 2 +- dev/ezcurl/Ezcurl/module-type-S/index.html | 2 +- dev/ezcurl/Ezcurl_core/Config/index.html | 2 +- dev/ezcurl/Ezcurl_core/Make/index.html | 2 +- dev/ezcurl/Ezcurl_core/index.html | 2 +- dev/ezcurl/Ezcurl_core/module-type-S/index.html | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/dev/ezcurl-lwt/Ezcurl_lwt/index.html b/dev/ezcurl-lwt/Ezcurl_lwt/index.html index 22fb47e..ae63e6b 100644 --- a/dev/ezcurl-lwt/Ezcurl_lwt/index.html +++ b/dev/ezcurl-lwt/Ezcurl_lwt/index.html @@ -1,2 +1,2 @@ -Ezcurl_lwt (ezcurl-lwt.Ezcurl_lwt)

Module Ezcurl_lwt

include Ezcurl_core
module Config = Ezcurl_core.Config
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
type meth =
| GET
| POST of Curl.curlHTTPPost list
| PUT
val string_of_meth : meth -> string
module type IO = sig ... end
module type S = sig ... end
module Make = Ezcurl_core.Make
include sig ... end
type 'a io = 'a Lwt.t
val http : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> url:string -> meth:Ezcurl_core.meth -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +Ezcurl_lwt (ezcurl-lwt.Ezcurl_lwt)

Module Ezcurl_lwt

include Ezcurl_core
module Config = Ezcurl_core.Config
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
val pp_response_info : Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
val pp_response : Format.formatter -> response -> unit
val string_of_response : response -> string
type 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 = sig ... end
module type S = sig ... end
module Make = Ezcurl_core.Make
include sig ... end
type 'a io = 'a Lwt.t
val http : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> meth:Ezcurl_core.meth -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.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) Pervasives.result io
val put : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
val post : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file diff --git a/dev/ezcurl-lwt/Ezcurl_lwt/module-type-S/index.html b/dev/ezcurl-lwt/Ezcurl_lwt/module-type-S/index.html index 7a70968..82669b1 100644 --- a/dev/ezcurl-lwt/Ezcurl_lwt/module-type-S/index.html +++ b/dev/ezcurl-lwt/Ezcurl_lwt/module-type-S/index.html @@ -1,2 +1,2 @@ -S (ezcurl-lwt.Ezcurl_lwt.S)

Module type Ezcurl_lwt.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +S (ezcurl-lwt.Ezcurl_lwt.S)

Module type Ezcurl_lwt.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io

General purpose HTTP call via cURL.

parameter url

the URL to query

parameter meth

which method to use (see meth)

parameter tries

how many times to retry in case of CURLE_AGAIN code

parameter client

a client to reuse (instead of allocating a new one)

parameter range

an optional byte range to fetch (either to get large pages by chunks, or to resume an interrupted download).

parameter config

configuration to set

parameter headers

headers of the query

val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:GET See http for more info.

val put : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:PUT See http for more info.

val post : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:(POST params) See http for more info.

\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl/index.html b/dev/ezcurl/Ezcurl/index.html index 8072879..9f39afd 100644 --- a/dev/ezcurl/Ezcurl/index.html +++ b/dev/ezcurl/Ezcurl/index.html @@ -1,2 +1,2 @@ -Ezcurl (ezcurl.Ezcurl)

Module Ezcurl

Synchronous API

include Ezcurl_core
module Config = Ezcurl_core.Config
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
type meth =
| GET
| POST of Curl.curlHTTPPost list
| PUT
val string_of_meth : meth -> string
module type IO = sig ... end
module type S = sig ... end
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 -> ?⁠headers:(string * string) list -> url:string -> meth:Ezcurl_core.meth -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +Ezcurl (ezcurl.Ezcurl)

Module Ezcurl

Synchronous API

include Ezcurl_core
module Config = Ezcurl_core.Config
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
val pp_response_info : Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
val pp_response : Format.formatter -> response -> unit
val string_of_response : response -> string
type 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 = sig ... end
module type S = sig ... end
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 -> ?⁠headers:(string * string) list -> url:string -> meth:Ezcurl_core.meth -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.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) Pervasives.result io
val put : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
val post : ?⁠tries:int -> ?⁠client:Ezcurl_core.t -> ?⁠config:Ezcurl_core.Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (Ezcurl_core.response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl/module-type-S/index.html b/dev/ezcurl/Ezcurl/module-type-S/index.html index 09ef5da..1c9ff75 100644 --- a/dev/ezcurl/Ezcurl/module-type-S/index.html +++ b/dev/ezcurl/Ezcurl/module-type-S/index.html @@ -1,2 +1,2 @@ -S (ezcurl.Ezcurl.S)

Module type Ezcurl.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +S (ezcurl.Ezcurl.S)

Module type Ezcurl.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io

General purpose HTTP call via cURL.

parameter url

the URL to query

parameter meth

which method to use (see meth)

parameter tries

how many times to retry in case of CURLE_AGAIN code

parameter client

a client to reuse (instead of allocating a new one)

parameter range

an optional byte range to fetch (either to get large pages by chunks, or to resume an interrupted download).

parameter config

configuration to set

parameter headers

headers of the query

val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:GET See http for more info.

val put : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:PUT See http for more info.

val post : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:(POST params) See http for more info.

\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl_core/Config/index.html b/dev/ezcurl/Ezcurl_core/Config/index.html index 8506a16..f36a2fc 100644 --- a/dev/ezcurl/Ezcurl_core/Config/index.html +++ b/dev/ezcurl/Ezcurl_core/Config/index.html @@ -1,2 +1,2 @@ -Config (ezcurl.Ezcurl_core.Config)

Module Ezcurl_core.Config

type t
val default : t
val verbose : bool -> t -> t
val authmethod : Curl.curlAuth list -> t -> t
val max_redirects : int -> t -> t
val follow_location : bool -> t -> t
val username : string -> t -> t
val password : string -> t -> t
\ No newline at end of file +Config (ezcurl.Ezcurl_core.Config)

Module Ezcurl_core.Config

type t
val default : t
val verbose : bool -> t -> t
val authmethod : Curl.curlAuth list -> t -> t
val max_redirects : int -> t -> t
val follow_location : bool -> t -> t
val username : string -> t -> t
val password : string -> t -> t
val pp : Format.formatter -> t -> unit
val to_string : t -> string
\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl_core/Make/index.html b/dev/ezcurl/Ezcurl_core/Make/index.html index 663375f..bf7e36f 100644 --- a/dev/ezcurl/Ezcurl_core/Make/index.html +++ b/dev/ezcurl/Ezcurl_core/Make/index.html @@ -1,2 +1,2 @@ -Make (ezcurl.Ezcurl_core.Make)

Module Ezcurl_core.Make

Parameters

Signature

type 'a io = 'a IO.t
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +Make (ezcurl.Ezcurl_core.Make)

Module Ezcurl_core.Make

Parameters

Signature

type 'a io = 'a IO.t
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io

General purpose HTTP call via cURL.

parameter url

the URL to query

parameter meth

which method to use (see meth)

parameter tries

how many times to retry in case of CURLE_AGAIN code

parameter client

a client to reuse (instead of allocating a new one)

parameter range

an optional byte range to fetch (either to get large pages by chunks, or to resume an interrupted download).

parameter config

configuration to set

parameter headers

headers of the query

val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:GET See http for more info.

val put : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:PUT See http for more info.

val post : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:(POST params) See http for more info.

\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl_core/index.html b/dev/ezcurl/Ezcurl_core/index.html index 523b8d0..d128256 100644 --- a/dev/ezcurl/Ezcurl_core/index.html +++ b/dev/ezcurl/Ezcurl_core/index.html @@ -1,2 +1,2 @@ -Ezcurl_core (ezcurl.Ezcurl_core)

Module Ezcurl_core

Core signatures and implementation

module Config : sig ... end
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
type meth =
| GET
| POST of Curl.curlHTTPPost list
| PUT
val string_of_meth : meth -> string
module type IO = sig ... end
module type S = sig ... end
module Make : functor (IO : IO) -> S with type 'a io = 'a IO.t
\ No newline at end of file +Ezcurl_core (ezcurl.Ezcurl_core)

Module Ezcurl_core

Core signatures and implementation

module Config : sig ... end
type t = Curl.t
val make : ?⁠set_opts:(t -> unit) -> unit -> t
val delete : t -> unit
val with_client : ?⁠set_opts:(t -> unit) -> (t -> 'a) -> 'a

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

type response_info = {
ri_response_time : float;
ri_redirect_count : int;
}
val pp_response_info : Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type response = {
code : int;
headers : (string * string) list;
body : string;
info : response_info;
}
val pp_response : Format.formatter -> response -> unit
val string_of_response : response -> string
type 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 = sig ... end
module type S = sig ... end
module Make : functor (IO : IO) -> S with type 'a io = 'a IO.t
\ No newline at end of file diff --git a/dev/ezcurl/Ezcurl_core/module-type-S/index.html b/dev/ezcurl/Ezcurl_core/module-type-S/index.html index e387c69..a1fde4b 100644 --- a/dev/ezcurl/Ezcurl_core/module-type-S/index.html +++ b/dev/ezcurl/Ezcurl_core/module-type-S/index.html @@ -1,2 +1,2 @@ -S (ezcurl.Ezcurl_core.S)

Module type Ezcurl_core.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io
val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io
\ No newline at end of file +S (ezcurl.Ezcurl_core.S)

Module type Ezcurl_core.S

Main Signature

type 'a io
val http : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> meth:meth -> unit -> (response, Curl.curlCode * string) Pervasives.result io

General purpose HTTP call via cURL.

parameter url

the URL to query

parameter meth

which method to use (see meth)

parameter tries

how many times to retry in case of CURLE_AGAIN code

parameter client

a client to reuse (instead of allocating a new one)

parameter range

an optional byte range to fetch (either to get large pages by chunks, or to resume an interrupted download).

parameter config

configuration to set

parameter headers

headers of the query

val get : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠range:string -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:GET See http for more info.

val put : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:PUT See http for more info.

val post : ?⁠tries:int -> ?⁠client:t -> ?⁠config:Config.t -> ?⁠headers:(string * string) list -> params:Curl.curlHTTPPost list -> url:string -> unit -> (response, Curl.curlCode * string) Pervasives.result io

Shortcut for http ~meth:(POST params) See http for more info.

\ No newline at end of file