package http-multipart-formdata

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

type reader

and read_result = [

]

and input = [

]

and part_header

Represents a parsed multipart part header data.

and boundary

Represents the multipart boundary value.

val 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.

val 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.

val read_part : reader -> read_result

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

val unconsumed : reader -> Cstruct.t

val name : part_header -> string

name t returns the form field name

val content_type : part_header -> string

content_type t returns the part content-type.

val filename : part_header -> string option

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

val find : string -> part_header -> string option

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

val pp_part_header : Format.formatter -> part_header -> unit

val pp_read_result : Format.formatter -> read_result -> unit

val pp_boundary : Format.formatter -> boundary -> unit