package mrmime

You can search for identifiers within the package.

in-package search v0.2.0

package mrmime

mrmime
- Mrmime
  - Address
    
    Decoder
    
    Encoder
  - Content_encoding
    
    Decoder
    
    Encoder
  - Content_type
    
    Decoder
    
    Encoder
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Date
    
    Day
    
    Decoder
    
    Encoder
    
    Month
    
    Zone
  - Encoded_word
    
    Decoder
    
    Encoder
  - Field
    
    Decoder
    
    Encoder
  - Field_name
    
    Decoder
    
    Encoder
  - Group
    
    Decoder
    
    Encoder
    
    Phrase
  - Hd
  - Header
    
    Decoder
    
    Encoder
  - Iana
    
    Map
    
    Set
  - Location
  - Mail
  - Mailbox
    
    Decoder
    
    Domain
    
    Encoder
    
    Literal_domain
    
    Local
    
    Phrase
  - MessageID
    
    Decoder
    
    Domain
    
    Encoder
  - Mt
  - Unstructured
    
    Craft
    
    Decoder
    
    Encoder

Legend:
Library
Module
Module type
Parameter
Class
Class type

type decoder

Type of decoder.

type decode = [

| `Field of Field.field Location.with_location
| `Await
| `End of string
| `Malformed of string

]

val decoder : 
  ?p:Field.witness Mrmime__.Field_name.Map.t ->
  Bigstringaf.t ->
  decoder

decoder ?p buf returns a decoder with a set of field-name binded with expected kind of value. When the decoder will decode value of a given field-name, it will try to extract expected value describe by the given Field.witness or it returns a Unstructured.t.

val decode : decoder -> decode

decode decoder is:

`Field field when extracted a field.
`Await when the decoder wants more input.
`End trailer when we reach end of the header. trailer is what the user gaves which is not the part of the header.
`Malformed err we we reach an error while decoding.

val src : 
  decoder ->
  string ->
  int ->
  int ->
  (unit, [> Rresult.R.msg ]) Stdlib.result

src decoder src off len gives more input to decoder. The function can fail when given input is bigger than internal buffer of decoder (see decoder).