package toml

You can search for identifiers within the package.

in-package search v0.2.0

package toml

toml
- Toml
  - Compare
  - Parser
  - Printer
  - Table
    
    Key
  - Value
    
    Of
    
    Array
    
    To
    
    Array

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parses raw data into Toml data structures

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

exception Error of string * location

Exception raised when a parsing error occurs. Contains a (message, location) tuple.

val parse : Lexing.lexbuf -> string -> Value.table

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

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

since 2.0.0

val from_string : string -> Value.table

Given an UTF-8 string, returns a Toml table.

raises Toml.Parser.Error
if the string is not valid Toml.

since 2.0.0

val from_channel : Pervasives.in_channel -> Value.table

Given an input channel, returns a Toml table.

raises Toml.Parser.Error
if the data in the channel is not valid Toml.

since 2.0.0

val from_filename : string -> Value.table

Given a filename, returns a Toml table.

raises Toml.Parser.Error
if the data in the file is not valid Toml.

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

since 2.0.0