package http-multipart-formdata

  1. Overview
  2. Docs
package http-multipart-formdata
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Http_multipart_formdataSource

Http_multipart_formdata is a non-blocking, streaming HTTP multipart formdata parser. Its design is based on two main ideas:

  • The parser should stream the results as soon as possible in a non-buffered, non-backtracking manner; and
  • The parser input must be non-blocking and incremental in nature.

The parser implements HTTP multipart/form-data standard as defined in RFC 7578.

Types

Sourcetype reader

reader represents a HTTP multipart formdata reader.

Sourceand read = [
  1. | `End
    (*

    The reader has completed reading.

    *)
  2. | `Header of part_header
    (*

    Multipart part header data.

    *)
  3. | `Body of Cstruct.t
    (*

    Multipart part body data.

    *)
  4. | `Body_end
    (*

    reader has completed reading the Multipart body data.

    *)
  5. | `Awaiting_input of [ `Cstruct of Cstruct.t | `Eof ] -> read
    (*

    The reader is waiting for it to be provided with input data. This is only returned when `Incremental is chosen as input.

    *)
  6. | `Error of string
]

read represents both the current state and data read by a reader.

Represents an error in input data.

Sourceand input = [
  1. | `Cstruct of Cstruct.t
    (*

    A bigstring input.

    *)
  2. | `Incremental
    (*

    The caller of the library periodically provides input to the parser.

    *)
]
Sourceand part_header

Represents a parsed multipart part header data.

Sourceand boundary

Represents the multipart boundary value.

Mulipart Boundary parser

Sourceval boundary : string -> (boundary, string) result

boundary content_type parses content_type to extract boundary value. content_type is the HTTP request Content-Type header value.

  let content_type =
    "multipart/form-data; \
     boundary=---------------------------735323031399963166993862150"
  in
  Http_multipart_formdata.boundary content_type

Multipart Reader

Sourceval reader : ?read_buffer_size:int -> boundary -> input -> reader

reader ?read_buffer_size boundary input creates reader. The default value for read_buffer_size is 1KB.

Sourceval read : reader -> read

read_part ?read_body_len ~boundary reader reads a http multipart body and returns a read value.

Sourceval unconsumed : reader -> Cstruct.t

uncoonsumed rader returns any leftover data still remaining after reader returns `End.

Part header

Sourceval name : part_header -> string

name t returns the form field name

Sourceval content_type : part_header -> string

content_type t returns the part content-type.

Sourceval filename : part_header -> string option

filename t returns the uploaded filename is the multipart is a file

Sourceval find : string -> part_header -> string option

param_value name t returns the multipart parameter value with name name.

Pretty Printers

Sourceval pp_part_header : Format.formatter -> part_header -> unit
Sourceval pp_read_result : Format.formatter -> read -> unit
Sourceval pp_boundary : Format.formatter -> boundary -> unit