package yaml

You can search for identifiers within the package.

in-package search v0.2.0

yaml
- Yaml
  - Stream
    
    Event
    
    Mark
  - Util
yaml.bindings
- Yaml_bindings
  - M
    
    C
    
    F
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
    
    F
    
    Intptr
    
    Infix
    
    Ptrdiff
    
    Infix
    
    Uintptr
    
    Infix
    
    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

Definition of an individual event during a processing stream

type pos = {

start_mark : Mark.t;
end_mark : Mark.t;

}

Delimited positioning information for an event in the document.

type t =

| Stream_start of {
1. encoding : encoding;
}
| Document_start of {
1. version : version option;
2. implicit : bool;
}
| Document_end of {
1. implicit : bool;
}
| Mapping_start of {
1. anchor : string option;
2. tag : string option;
3. implicit : bool;
4. style : layout_style;
}
| Mapping_end
| Stream_end
| Scalar of scalar
| Sequence_start of {
1. anchor : string option;
2. tag : string option;
3. implicit : bool;
4. style : layout_style;
}
| Sequence_end
| Alias of {
1. anchor : string;
}
| Nothing

t represents a single event in a YAML processing stream.

These may be produced by a parser or consumed by an emitter. A valid sequence of events should obey the grammar:

stream ::= STREAM-START document* STREAM-END
document ::= DOCUMENT-START node DOCUMENT-END
node ::= ALIAS | SCALAR | sequence | mapping
sequence ::= SEQUENCE-START node* SEQUENCE-END
mapping ::= MAPPING-START (node node)* MAPPING-END