package piaf

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Piaf.ClientSource

Sourcetype t
Sourceval create : ?config:Config.t -> Uri.t -> (t, Error.t) Lwt_result.t

create ?config uri opens a connection to uri (initially) that can be used to issue multiple requests to the remote endpoint.

A client instance represents a connection to a single remote endpoint, and the remaining functions in this module will issue requests to that endpoint only.

Sourceval head : t -> ?headers:(string * string) list -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval get : t -> ?headers:(string * string) list -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval post : t -> ?headers:(string * string) list -> ?body:Body.t -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval put : t -> ?headers:(string * string) list -> ?body:Body.t -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval patch : t -> ?headers:(string * string) list -> ?body:Body.t -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval delete : t -> ?headers:(string * string) list -> ?body:Body.t -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval request : t -> ?headers:(string * string) list -> ?body:Body.t -> meth:Method.t -> string -> (Response.t, Error.t) Lwt_result.t
Sourceval shutdown : t -> unit Lwt.t

shutdown t tears down the connection t and frees up all the resources associated with it.

Sourcemodule Oneshot : sig ... end
OCaml

Innovation. Community. Security.