package piaf

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Traversal
Conversion to Lwt_stream.t

package piaf

piaf
- Piaf
  - Body
  - Client
    
    Oneshot
  - Config
  - Cookies
    
    Cookie
    
    Set_cookie
  - Error
  - Form
    
    Multipart
  - Headers
    
    Well_known
    
    HTTP1
    
    HTTP2
  - IOVec
  - Method
  - Request
  - Response
  - Scheme
  - Server
    
    Error_response
    
    Handler
    
    Middleware
    
    Service
  - Status
  - Versions
    
    ALPN
    
    HTTP
    
    TLS
piaf.h2
- H2
  - Body
  - Client_connection
  - Config
  - Error_code
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Settings
  - Status
piaf.h2-lwt
- H2_lwt
  - Client
  - Server
piaf.h2-lwt-unix
- H2_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
piaf.hpack
- Hpack
  - Decoder
  - Encoder
piaf.httpaf
- Httpaf
  - Body
  - Client_connection
  - Config
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Status
  - Version
piaf.httpaf-lwt
- Httpaf_lwt
  - Client
  - Server
piaf.httpaf-lwt-unix
- Httpaf_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
piaf.multipart
- Multipart
  - Pp
piaf.multipart_form
- Multipart_form
  - Content_disposition
  - Content_encoding
  - Content_type
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Field
  - Field_name
  - Header
    
    Decoder

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

type length = [

| `Fixed of Stdlib.Int64.t
| `Chunked
| `Error of [ `Bad_request | `Bad_gateway | `Internal_server_error ]
| `Unknown
| `Close_delimited

]

val length : t -> length

val empty : t

val of_stream : ?length:length -> Bigstringaf.t IOVec.t Lwt_stream.t -> t

val of_string_stream : ?length:length -> string Lwt_stream.t -> t

val of_string : string -> t

val of_bigstring : ?off:int -> ?len:int -> Bigstringaf.t -> t

val to_string : t -> (string, Error.t) Lwt_result.t

val drain : t -> (unit, Error.t) Lwt_result.t

val is_closed : t -> bool

val closed : t -> (unit, Error.t) Lwt_result.t

val when_closed : t -> ((unit, Error.t) Stdlib.result -> unit) -> unit

Traversal

val fold : 
  (Bigstringaf.t IOVec.t -> 'a -> 'a) ->
  t ->
  'a ->
  ('a, Error.t) Lwt_result.t

val fold_string : (string -> 'a -> 'a) -> t -> 'a -> ('a, Error.t) Lwt_result.t

val fold_s : 
  (Bigstringaf.t Faraday.iovec -> 'a -> 'a Lwt.t) ->
  t ->
  'a ->
  ('a, Error.t) Lwt_result.t

val fold_string_s : 
  (string -> 'a -> 'a Lwt.t) ->
  t ->
  'a ->
  ('a, Error.t) Lwt_result.t

val iter : 
  (Bigstringaf.t Faraday.iovec -> unit) ->
  t ->
  (unit, Error.t) Lwt_result.t

val iter_string : (string -> unit) -> t -> (unit, Error.t) Lwt_result.t

val iter_s : 
  (Bigstringaf.t Faraday.iovec -> unit Lwt.t) ->
  t ->
  (unit, Error.t) Lwt_result.t

val iter_string_s : (string -> unit Lwt.t) -> t -> (unit, Error.t) Lwt_result.t

val iter_p : 
  (Bigstringaf.t Faraday.iovec -> unit Lwt.t) ->
  t ->
  (unit, Error.t) Lwt_result.t

val iter_string_p : (string -> unit Lwt.t) -> t -> (unit, Error.t) Lwt_result.t

val iter_n : 
  ?max_concurrency:int ->
  (Bigstringaf.t Faraday.iovec -> unit Lwt.t) ->
  t ->
  (unit, Error.t) Lwt_result.t

val iter_string_n : 
  ?max_concurrency:int ->
  (string -> unit Lwt.t) ->
  t ->
  (unit, Error.t) Lwt_result.t

Conversion to `Lwt_stream.t`

The functions below convert a Piaf.Body.t to an Lwt_stream.t. These functions should be used sparingly, and only when interacting with other APIs that require their argument to be a Lwt_stream.t.

These functions return a tuple of two elements. In addition to returning a Lwt_stream.t, the tuple's second element is a promise that will sleep until the stream is consumed (and closed). This promise will resolve to Ok () if the body was successfully transferred from the peer; otherwise, it will return Error error with an error of type Error.t detailing the failure that caused the body to not have been fully transferred from the peer.

val to_stream : 
  t ->
  Bigstringaf.t IOVec.t Lwt_stream.t * (unit, Error.t) Lwt_result.t

val to_string_stream : t -> string Lwt_stream.t * (unit, Error.t) Lwt_result.t

package piaf

Traversal

Conversion to Lwt_stream.t

Conversion to `Lwt_stream.t`