package piaf

You can search for identifiers within the package.

in-package search v0.2.0

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
    
    Client_runtime
  - Server
    
    Server_runtime
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
    
    Client_runtime
  - Server
    
    Server_runtime
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

Response

A server-generated message to a

equest

.

type t = {

version : Version.t;
status : Status.t;
reason : string;
headers : Headers.t;

}

val create : 
  ?reason:string ->
  ?version:Version.t ->
  ?headers:Headers.t ->
  Status.t ->
  t

create ?reason ?version ?headers status creates an HTTP response with the given parameters. For typical use cases, it's sufficient to provide values for headers and status.

val body_length : 
  ?proxy:bool ->
  request_method:Method.standard ->
  t ->
  [ `Fixed of Int64.t
  | `Chunked
  | `Close_delimited
  | `Error of [ `Bad_gateway | `Internal_server_error ] ]

body_length ?proxy ~request_method t is the length of the message body accompanying t assuming it is a response to a request whose method was request_method. If the calling code is acting as a proxy, it should pass ~proxy:true. This optional parameter only affects error reporting.

See RFC7230§3.3.3 for more details.

val persistent_connection : ?proxy:bool -> t -> bool

persistent_connection ?proxy t indicates whether the connection for t can be reused for multiple requests and responses. If the calling code is acting as a proxy, it should pass ~proxy:true.

See RFC7230§6.3 for more details.

val pp_hum : Format.formatter -> t -> unit