package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

Easy API library and tools

Install

dune-project

Dependency

github.com Readme Changelog LGPL-2.1-only License Edit opam file Versions (6)

Authors

Maintainers

F

Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>

Sources

2.1.0.tar.gz

md5=e1d03d141ef977fbd4521256c91431f1

sha512=51b0cc4e6afb0cd5ab55c0c40964946b79e0c2cc903b5d08c594292eec723a25e25463175d704c02fe559e2af5d95973514c248a603ad28ec0230c35ad2d6492

doc/ez_api.cohttp_base/EzCohttp_base/Make/argument-1-Client/index.html

Parameter `Make.Client`

type ctx

parameter ctx
If provided, no connection cache is used, but Connection_cache.Make_no_cache.create is used to resolve uri and create a dedicated connection with ctx.

In most cases you should use the more specific helper calls in the interface rather than invoke this function directly. See head, get and post for some examples.

include Cohttp.Generic.Client.S
  with type 'a io = 'a Lwt.t
   and type body = Cohttp_lwt__.Body.t
   and type 'a with_context = ?ctx:ctx -> 'a

type 'a io = 'a Lwt.t

type 'a with_context = ?ctx:ctx -> 'a

type body = Cohttp_lwt.Body.t

val map_context : 'a with_context -> ('a -> 'b) -> 'b with_context

val call : 
  (?headers:Http.Header.t ->
    ?body:body ->
    ?chunked:bool ->
    Http.Method.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

call ?headers ?body ?chunked meth uri

returns
(response, response_body) Consume response_body in a timely fashion. Please see call about how and why.

parameter chunked
use chunked encoding if true. The default is false for compatibility reasons.

val head : (?headers:Http.Header.t -> Uri.t -> Http.Response.t io) with_context

val get : 
  (?headers:Http.Header.t -> Uri.t -> (Http.Response.t * body) io) with_context

val delete : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

val post : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

val put : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

val patch : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

val set_cache : Cohttp_lwt.S.call -> unit

Provide a function used to process requests. Please see call. The provided function is only used when no ctx argument is passed to the convenience functions below.

val post_form : 
  ?ctx:ctx ->
  ?headers:Http.Header.t ->
  params:(string * string list) list ->
  Uri.t ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t

val callv : 
  ?ctx:ctx ->
  Uri.t ->
  (Http.Request.t * Cohttp_lwt.Body.t) Lwt_stream.t ->
  (Http.Response.t * Cohttp_lwt.Body.t) Lwt_stream.t Lwt.t

deprecated
use Cohttp_lwt.Connection instead.