diff --git a/ezcurl-lwt/Ezcurl_lwt/index.html b/ezcurl-lwt/Ezcurl_lwt/index.html index 759932c..59c80be 100644 --- a/ezcurl-lwt/Ezcurl_lwt/index.html +++ b/ezcurl-lwt/Ezcurl_lwt/index.html @@ -1,10 +1,10 @@ -Ezcurl_lwt (ezcurl-lwt.Ezcurl_lwt)

Module Ezcurl_lwt

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

Configuration for the client.

type t = private Ezcurl_core.t = {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since NEXT_RELEASE

val make : +Ezcurl_lwt (ezcurl-lwt.Ezcurl_lwt)

Module Ezcurl_lwt

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

Configuration for the client.

type t = private Ezcurl_core.t = {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since 0.3

val make : ?set_opts:(Curl.t -> unit) -> ?cookiejar_file:string -> ?enable_session_cookies:bool -> unit -> - t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since NEXT_RELEASE)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since NEXT_RELEASE)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since NEXT_RELEASE
module Cookies = Ezcurl_core.Cookies

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body response = 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : + t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since 0.3)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since 0.3)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since 0.3
module Cookies = Ezcurl_core.Cookies

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body response = 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a response -> diff --git a/ezcurl/Ezcurl/index.html b/ezcurl/Ezcurl/index.html index a0320cb..01f2417 100644 --- a/ezcurl/Ezcurl/index.html +++ b/ezcurl/Ezcurl/index.html @@ -1,10 +1,10 @@ -Ezcurl (ezcurl.Ezcurl)

Module Ezcurl

Synchronous API

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

Configuration for the client.

type t = private Ezcurl_core.t = {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since NEXT_RELEASE

val make : +Ezcurl (ezcurl.Ezcurl)

Module Ezcurl

Synchronous API

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

Configuration for the client.

type t = private Ezcurl_core.t = {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since 0.3

val make : ?set_opts:(Curl.t -> unit) -> ?cookiejar_file:string -> ?enable_session_cookies:bool -> unit -> - t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since NEXT_RELEASE)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since NEXT_RELEASE)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since NEXT_RELEASE
module Cookies = Ezcurl_core.Cookies

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body response = 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : + t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since 0.3)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since 0.3)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since 0.3
module Cookies = Ezcurl_core.Cookies

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body response = 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a response -> diff --git a/ezcurl/Ezcurl_core/Cookies/index.html b/ezcurl/Ezcurl_core/Cookies/index.html index a0457ef..793419f 100644 --- a/ezcurl/Ezcurl_core/Cookies/index.html +++ b/ezcurl/Ezcurl_core/Cookies/index.html @@ -1,2 +1,2 @@ -Cookies (ezcurl.Ezcurl_core.Cookies)

Module Ezcurl_core.Cookies

Cookie handling.

  • since NEXT_RELEASE
val flush_cookiejar : t -> unit

If cookiejar_file was provided in make, this flushes the current set of cookies to the provided file.

  • since NEXT_RELEASE
val reload_cookiejar : t -> unit

If cookiejar_file was provided in make, this reloads cookies from the provided file.

  • since NEXT_RELEASE
val get_cookies : t -> string list

Get cookie list (in netscape format)

val set_cookies : t -> string list -> unit

Set cookie list (in netscape format)

val transfer : t -> t -> unit

transfer c1 c2 copies cookies in c1 into c2

+Cookies (ezcurl.Ezcurl_core.Cookies)

Module Ezcurl_core.Cookies

Cookie handling.

  • since 0.3
val flush_cookiejar : t -> unit

If cookiejar_file was provided in make, this flushes the current set of cookies to the provided file.

  • since 0.3
val reload_cookiejar : t -> unit

If cookiejar_file was provided in make, this reloads cookies from the provided file.

  • since 0.3
val get_cookies : t -> string list

Get cookie list (in netscape format)

val set_cookies : t -> string list -> unit

Set cookie list (in netscape format)

val transfer : t -> t -> unit

transfer c1 c2 copies cookies in c1 into c2

diff --git a/ezcurl/Ezcurl_core/Make/class-type-input_stream/index.html b/ezcurl/Ezcurl_core/Make/class-type-input_stream/index.html index 69017bf..0b1a9aa 100644 --- a/ezcurl/Ezcurl_core/Make/class-type-input_stream/index.html +++ b/ezcurl/Ezcurl_core/Make/class-type-input_stream/index.html @@ -1,2 +1,2 @@ -input_stream (ezcurl.Ezcurl_core.Make.input_stream)

Class type Make.input_stream

Push-based stream of bytes

  • since NEXT_RELEASE
method on_close : unit -> unit
method on_input : bytes -> int -> int -> unit
+input_stream (ezcurl.Ezcurl_core.Make.input_stream)

Class type Make.input_stream

Push-based stream of bytes

  • since 0.3
method on_close : unit -> unit
method on_input : bytes -> int -> int -> unit
diff --git a/ezcurl/Ezcurl_core/Make/index.html b/ezcurl/Ezcurl_core/Make/index.html index 548a5e5..95f7189 100644 --- a/ezcurl/Ezcurl_core/Make/index.html +++ b/ezcurl/Ezcurl_core/Make/index.html @@ -20,7 +20,7 @@ meth:meth -> write_into:input_stream -> unit -> - (unit response, Curl.curlCode * string) Stdlib.result io

HTTP call via cURL, with a streaming response body. The body is given to write_into by chunks, then write_into#on_close () is called and the response is returned.

  • since NEXT_RELEASE
val get : + (unit response, Curl.curlCode * string) Stdlib.result io

HTTP call via cURL, with a streaming response body. The body is given to write_into by chunks, then write_into#on_close () is called and the response is returned.

  • since 0.3
val get : ?tries:int -> ?client:t -> ?config:Config.t -> diff --git a/ezcurl/Ezcurl_core/index.html b/ezcurl/Ezcurl_core/index.html index 3f66e3e..9a54e53 100644 --- a/ezcurl/Ezcurl_core/index.html +++ b/ezcurl/Ezcurl_core/index.html @@ -1,10 +1,10 @@ -Ezcurl_core (ezcurl.Ezcurl_core)

Module Ezcurl_core

Core signatures and implementation

module Config : sig ... end

Configuration for the client.

type t = private {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since NEXT_RELEASE

val make : +Ezcurl_core (ezcurl.Ezcurl_core)

Module Ezcurl_core

Core signatures and implementation

module Config : sig ... end

Configuration for the client.

type t = private {
  1. curl : Curl.t;
}

A client, i.e. a cURL instance. The wrapping record has been present since 0.3

val make : ?set_opts:(Curl.t -> unit) -> ?cookiejar_file:string -> ?enable_session_cookies:bool -> unit -> - t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since NEXT_RELEASE)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since NEXT_RELEASE)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since NEXT_RELEASE
module Cookies : sig ... end

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : + t

Create a new client.

  • parameter set_opts

    called before returning the client, to set options

  • parameter cookiejar_file

    if provided, tell curl to use the given file path to store/load cookies (since 0.3)

  • parameter enable_session_cookies

    if provided, enable cookie handling in curl so it store/load cookies (since 0.3)

val delete : t -> unit

Delete the client. It cannot be used anymore.

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

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

val set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

  • since 0.3
module Cookies : sig ... end

Cookie handling.

type 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.

val pp_response_info : Stdlib.Format.formatter -> response_info -> unit
val string_of_response_info : response_info -> string
type 'body 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 : 'body;
    (*

    Response body, or ""

    *)
  4. info : response_info;
    (*

    Information about the response

    *)
}

Response for a given request.

val pp_response_with : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a response -> diff --git a/ezcurl/Ezcurl_core/module-type-S/class-type-input_stream/index.html b/ezcurl/Ezcurl_core/module-type-S/class-type-input_stream/index.html index f35fc7d..88c0ca7 100644 --- a/ezcurl/Ezcurl_core/module-type-S/class-type-input_stream/index.html +++ b/ezcurl/Ezcurl_core/module-type-S/class-type-input_stream/index.html @@ -1,2 +1,2 @@ -input_stream (ezcurl.Ezcurl_core.S.input_stream)

Class type S.input_stream

Push-based stream of bytes

  • since NEXT_RELEASE
method on_close : unit -> unit
method on_input : bytes -> int -> int -> unit
+input_stream (ezcurl.Ezcurl_core.S.input_stream)

Class type S.input_stream

Push-based stream of bytes

  • since 0.3
method on_close : unit -> unit
method on_input : bytes -> int -> int -> unit
diff --git a/ezcurl/Ezcurl_core/module-type-S/index.html b/ezcurl/Ezcurl_core/module-type-S/index.html index a998ebe..9929e09 100644 --- a/ezcurl/Ezcurl_core/module-type-S/index.html +++ b/ezcurl/Ezcurl_core/module-type-S/index.html @@ -20,7 +20,7 @@ meth:meth -> write_into:input_stream -> unit -> - (unit response, Curl.curlCode * string) Stdlib.result io

HTTP call via cURL, with a streaming response body. The body is given to write_into by chunks, then write_into#on_close () is called and the response is returned.

  • since NEXT_RELEASE
val get : + (unit response, Curl.curlCode * string) Stdlib.result io

HTTP call via cURL, with a streaming response body. The body is given to write_into by chunks, then write_into#on_close () is called and the response is returned.

  • since 0.3
val get : ?tries:int -> ?client:t -> ?config:Config.t ->