Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package http-multipart-formdata
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
and read = [ | `End(*The reader has completed reading.
*)| `Header of part_header(*Multipart part header data.
*)| `Body of Cstruct.t(*Multipart part body data.
*)| `Body_end(*
*)readerhas completed reading the Multipart body data.| `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
*)`Incrementalis chosen asinput.| `Error of string
]and input = [ | `Cstruct of Cstruct.t(*A bigstring input.
*)| `Incremental(*The caller of the library periodically provides input to the parser.
*)
]Mulipart Boundary parser
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_typeMultipart Reader
reader ?read_buffer_size boundary input creates reader. The default value for read_buffer_size is 1KB.
read_part ?read_body_len ~boundary reader reads a http multipart body and returns a read value.
uncoonsumed rader returns any leftover data still remaining after reader returns `End.
Part header
val name : part_header -> stringname t returns the form field name
val content_type : part_header -> stringcontent_type t returns the part content-type.
val filename : part_header -> string optionfilename t returns the uploaded filename is the multipart is a file
val find : string -> part_header -> string optionparam_value name t returns the multipart parameter value with name name.
Pretty Printers
val pp_part_header : Format.formatter -> part_header -> unitval pp_read_result : Format.formatter -> read -> unitval pp_boundary : Format.formatter -> boundary -> unit