multipartkit/content_disposition

Types

ContentDisposition

opaque </>

A parsed Content-Disposition header value.

Opaque — inspect through disposition/1, name/1, filename/1, and params/1. The internal layout may grow more fields (a parsed creation-date, etc.) without breaking external pattern matches.

Semantics of each accessor:

disposition/1 is lowercased ("form-data", "attachment", …).
name/1 and filename/1 are convenience accessors decoded from RFC 5987 / RFC 8187 *-form when present (with the *-form taking precedence over the plain form), otherwise from the plain parameter value with surrounding quotes removed and backslash-escapes resolved per RFC 7230 quoted-string rules.
params/1 contains every parameter as it appeared in the input including filename and name, in order. Duplicate parameter names are preserved left-to-right; only the first occurrence wins for the convenience name/filename fields.

pub opaque type ContentDisposition

Values

disposition

</>

pub fn disposition(parsed: ContentDisposition) -> String

The disposition token, lowercased.

filename

</>

pub fn filename(
  parsed: ContentDisposition,
) -> option.Option(String)

The decoded filename parameter, or None if absent. Honours RFC 5987 / RFC 8187 *-form precedence.

name

</>

pub fn name(parsed: ContentDisposition) -> option.Option(String)

The decoded name parameter, or None if absent.

params

</>

pub fn params(
  parsed: ContentDisposition,
) -> List(#(String, String))

All raw parameters as (key, value) pairs in input order. Includes name and filename (and *-form variants) before convenience decoding.

parse

</>

pub fn parse(
  value: String,
) -> Result(ContentDisposition, error.MultipartError)

Parse a Content-Disposition header value.

Returns Error(InvalidContentDisposition(value)) for unparseable input.