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
- Library yaml
  - Yaml
    
    Stream
    
    Mark
    
    Event
- Library yaml.bindings
  - Yaml_bindings
    
    T
    
    M
    
    C
    
    Intptr
    
    Ptrdiff
    
    Uintptr
    
    CArray
    
    FOREIGN
    
    TYPE
    
    Root
- Library yaml.c
  - Yaml_c
- Library yaml.ffi
  - Yaml_ffi
    
    G
    
    CI
    
    M
    
    C
    
    Intptr
    
    Ptrdiff
    
    Uintptr
    
    CArray
    
    FOREIGN
    
    TYPE
    
    Root
- Library yaml.types
  - Yaml_types
    
    G
    
    Intptr
    
    Ptrdiff
    
    Uintptr
    
    CArray
    
    FOREIGN
    
    TYPE
    
    Root
    
    M
    
    Encoding
    
    Error
    
    Scalar_style
    
    Sequence_style
    
    Mapping_style
    
    Token_type
    
    Event_type
    
    M
    
    Version_directive
    
    Tag_directive
    
    Mark
    
    Token
    
    Stream_start
    
    Alias
    
    Anchor
    
    Scalar
    
    Version
    
    Data
    
    Event
    
    Stream_start
    
    Mapping_start
    
    Scalar
    
    Document_start
    
    Tag_directives
    
    Document_end
    
    Sequence_start
    
    Alias
    
    Data
    
    Parser
    
    Emitter
- Library yaml.unix
  - Yaml_unix
- Library yaml_bindings_types
  - Yaml_bindings_types
    
    Encoding
    
    Error
    
    Scalar_style
    
    Sequence_style
    
    Mapping_style
    
    Token_type
    
    Event_type
    
    M
    
    Version_directive
    
    Tag_directive
    
    Mark
    
    Token
    
    Stream_start
    
    Alias
    
    Anchor
    
    Scalar
    
    Version
    
    Data
    
    Event
    
    Stream_start
    
    Mapping_start
    
    Scalar
    
    Document_start
    
    Tag_directives
    
    Document_end
    
    Sequence_start
    
    Alias
    
    Data
    
    Parser
    
    Emitter
- Sources
  - yaml
    
    stream.ml
    
    types.ml
    
    yaml.ml
    
    yaml__.ml
  - yaml.bindings
    
    yaml_bindings.ml
  - yaml.c
    
    yaml_c.ml
  - yaml.ffi
    
    g.ml
    
    m.ml
    
    yaml_ffi.ml
  - yaml.types
    
    g.ml
    
    m.ml
    
    yaml_types.ml
  - yaml.unix
    
    yaml_unix.ml
  - yaml_bindings_types
    
    yaml_bindings_types.ml

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

Module `Yaml.Stream`Source

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.

Sourcemodule Mark : sig ... end

Position information for an event

Sourcemodule Event : sig ... end

Definition of an individual event during a processing stream

Parsing functions

Sourcetype parser

parser tracks the state of generating Event.t values.

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

parser () will allocate a fresh parser state.

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

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

Serialisation functions

Sourcetype emitter

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

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

Sourceval emitter_buf : emitter -> Bytes.t

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

Sourceval document_start : ?implicit:bool -> emitter -> unit res

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

Sourceval scalar : scalar -> emitter -> unit res

Sourceval alias : emitter -> string -> unit res

Sourceval stream_start : emitter -> encoding -> unit res

Sourceval stream_end : emitter -> unit res

Source

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

Sourceval sequence_end : emitter -> unit res

Source

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

Sourceval mapping_end : emitter -> unit res

Sourceval emitter_written : emitter -> int

Sourceval get_version : unit -> int * int * int

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

package yaml

Module Yaml.StreamSource

Parsing functions

Serialisation functions

Module `Yaml.Stream`Source