package piaf

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

HTTP Header.

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

HTTP Header.

Any part of a multipart/form-data document has a HTTP header which describes:

the type of contents.
the encoding used to transfer contents.
meta-data such as the associated name/key of contents.
some others meta information.

We allow the user to introspect the given header with useful functions.

type t

val assoc : Field_name.t -> t -> Field.field list

val exists : Field_name.t -> t -> bool

val content_type : t -> Content_type.t

content_type header returns the Content_type value of header. If this value does not exists, it return default value.

val content_encoding : t -> Content_encoding.t

content_encoding returns the Content_encoding value of header. If this value does not exists, it return default value.

val content_disposition : t -> Content_disposition.t option

content_disposition returns the Content_disposition value of header if it exists.

val to_list : t -> Field.field list

to_list hdr returns the list of fields into the given hdr header.

val of_list : Field.field list -> t

of_list lst returns a header from a list of Field.field.

val pp : t Fmt.t

module Decoder : sig ... end