package toml

You can search for identifiers within the package.

in-package search v0.2.0

package toml

toml
- Library toml
  - Toml
    
    Compare
    
    Lenses
    
    Lexer
    
    Menhir_parser
    
    Min
    
    Parser
    
    Printer
    
    Types
    
    Table
    
    Key
    
    Unicode
- Sources
  - toml
    
    compare.ml
    
    lenses.ml
    
    min.ml
    
    parser.ml
    
    printer.ml
    
    toml.ml
    
    types.ml
    
    unicode.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Toml.Parser`Source

Parses raw data into Toml data structures

Sourcetype location = {

source : string;
line : int;
column : int;
position : int;

}

The location of an error. The source gives the source file of the error. The other fields give the location of the error inside the source. They all start from one. The line is the line number, the column is the number of characters from the start of the line, and the position is the number of characters from the start of the source.

Sourcetype result = [

| `Ok of Types.table
| `Error of string * location

]

Parsing result. Either Ok or error (which contains a (message, location) tuple).

Sourceval parse : Lexing.lexbuf -> string -> result

Given a lexer buffer and a source (eg, a filename), returns a result.

raises Toml.Parser.result.`Error
if the buffer is not valid Toml.

since 2.0.0

Sourceval from_string : string -> result

Given an UTF-8 string, returns a result.

since 2.0.0

Sourceval from_channel : in_channel -> result

Given an input channel, returns a result.

since 2.0.0

Sourceval from_filename : string -> result

Given a filename, returns a result.

raises Stdlib.Sys_error
if the file could not be opened.

since 2.0.0

Sourceexception Error of string * location

Sourceval unsafe : result -> Types.table

A combinator to force the result. Raise Error if the result was `Error.

since 4.0.0

package toml

Module Toml.ParserSource

Module `Toml.Parser`Source