package yaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parsing functions
Serialisation functions

package yaml

yaml
- Yaml
  - Stream
    
    Event
    
    Mark
  - Util
yaml.bindings
- Yaml_bindings
  - M
    
    C
yaml.bindings.types
- Yaml_bindings_types
  - Encoding
  - Error
  - Event_type
  - M
    
    Emitter
    
    Event
    
    Alias
    
    Data
    
    Document_end
    
    Document_start
    
    Tag_directives
    
    Mapping_start
    
    Scalar
    
    Sequence_start
    
    Stream_start
    
    Mark
    
    Parser
    
    Tag_directive
    
    Token
    
    Alias
    
    Anchor
    
    Data
    
    Scalar
    
    Stream_start
    
    Version
    
    Version_directive
  - Mapping_style
  - Scalar_style
  - Sequence_style
  - Token_type
yaml.c
- Yaml_c
yaml.ffi
- Yaml_ffi
  - G
  - M
    
    C
yaml.types
- Yaml_types
  - G
  - M
    
    Emitter
    
    Event
    
    Alias
    
    Data
    
    Document_end
    
    Document_start
    
    Tag_directives
    
    Mapping_start
    
    Scalar
    
    Sequence_start
    
    Stream_start
    
    Mark
    
    Parser
    
    Tag_directive
    
    Token
    
    Alias
    
    Anchor
    
    Data
    
    Scalar
    
    Stream_start
    
    Version
    
    Version_directive
yaml.unix
- Yaml_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Low-level event streaming interface for parsing and emitting YAML files.

This module has a:

Stream.parser, which takes an input stream of bytes and produces a sequence of parsing events.
Stream.emitter, which takes a sequence of events and produces a stream of bytes.

The processes of parsing and presenting are inverse to each other. Any sequence of events produced by parsing a well-formed YAML document should be acceptable by the Emitter, which should produce an equivalent document. Similarly, any document produced by emitting a sequence of events should be acceptable for the Parser, which should produce an equivalent sequence of events.

module Mark : sig ... end

Position information for an event

module Event : sig ... end

Definition of an individual event during a processing stream

Parsing functions

type parser

parser tracks the state of generating Event.t values.

val parser : string -> (parser, [> Rresult.R.msg ]) Result.result

parser () will allocate a fresh parser state.

val do_parse : parser -> (Event.t * Event.pos) res

do_parse parser will generate the next parsing event from an initialised parser.

Serialisation functions

type emitter

emitter tracks the state of generating Event.t values for YAML output.

val emitter : ?len:int -> unit -> emitter res

emitter ?len () will allocate a new emitter state. Due to a temporary limitation in the implementation, len decides how large the fixed size buffer that the output is written into is. In the future, len will be redundant as the buffer will be dynamically allocated.

val emitter_buf : emitter -> Bytes.t

val emit : emitter -> Event.t -> unit res

val document_start : ?version:version -> ?implicit:bool -> emitter -> unit res

val document_end : ?implicit:bool -> emitter -> unit res

val scalar : scalar -> emitter -> unit res

val alias : emitter -> string -> unit res

val stream_start : emitter -> encoding -> unit res

val stream_end : emitter -> unit res

val sequence_start : 
  ?anchor:string ->
  ?tag:string ->
  ?implicit:bool ->
  ?style:layout_style ->
  emitter ->
  unit res

val sequence_end : emitter -> unit res

val mapping_start : 
  ?anchor:string ->
  ?tag:string ->
  ?implicit:bool ->
  ?style:layout_style ->
  emitter ->
  unit res

val mapping_end : emitter -> unit res

val emitter_written : emitter -> int

val get_version : unit -> int * int * int

library_version () returns the major, minor and patch version of the underlying libYAML implementation.