package piaf

You can search for identifiers within the package.

in-package search v0.2.0

piaf
- Piaf
  - Body
  - Cert
  - Client
    
    Oneshot
  - Config
  - Cookies
    
    Cookie
    
    Set_cookie
  - Error
  - Form
    
    Multipart
  - Headers
    
    Well_known
    
    HTTP1
    
    HTTP2
    
    Values
  - IOVec
  - Method
  - Request
  - Request_info
  - Response
    
    Upgrade
  - Scheme
  - Server
    
    Command
    
    Config
    
    HTTPS
    
    Error_response
    
    Handler
    
    Middleware
    
    Service
  - Status
  - Versions
    
    ALPN
    
    HTTP
    
    Raw
    
    TLS
  - Ws
    
    Descriptor
    
    Message
piaf.multipart
- Multipart
  - Pp
piaf.multipart_form
- Piaf_multipart_form
  - Content_disposition
    
    Decoder
    
    Encoder
  - Content_encoding
    
    Decoder
    
    Encoder
  - Content_type
    
    Decoder
    
    Encoder
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Field
    
    Decoder
    
    Encoder
  - Field_name
    
    Decoder
    
    Encoder
    
    Map
    
    Set
  - Header
    
    Decoder
    
    Encoder
  - Multipart_form
    
    Content_disposition
    
    Content_encoding
    
    Content_type
    
    Parameters
    
    Map
    
    Subtype
    
    Type
    
    Field
    
    Field_name
    
    Header
    
    Decoder
  - Rfc2046
piaf.sendfile
- Sendfile
piaf.stream
- Piaf_stream

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

val create : 
  ?config:Config.t ->
  sw:Eio.Switch.t ->
  Eio_unix.Stdenv.base ->
  Uri.t ->
  (t, [> Error.client ]) Stdlib.result

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.

val head : 
  t ->
  ?headers:(string * string) list ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val get : 
  t ->
  ?headers:(string * string) list ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val post : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val put : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val patch : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val delete : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val request : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  meth:Method.t ->
  string ->
  (Response.t, [> Error.t ]) Stdlib.result

val send : t -> Request.t -> (Response.t, [> Error.t ]) Stdlib.result

val ws_upgrade : 
  t ->
  ?headers:(string * string) list ->
  string ->
  (Ws.Descriptor.t, [> Error.t ]) Stdlib.result

val shutdown : t -> unit

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

module Oneshot : sig ... end