Ruby  2.0.0p247(2013-06-27revision41674)
Data Fields
yaml_event_s Struct Reference

The event structure. More...

#include <yaml.h>

Data Fields

yaml_event_type_t type
 The event type.
union {
   struct {
      yaml_encoding_t   encoding
 The document encoding.
   }   stream_start
 The stream parameters (for YAML_STREAM_START_EVENT).
   struct {
      yaml_version_directive_t *   version_directive
 The version directive.
      struct {
         yaml_tag_directive_t *   start
 The beginning of the tag directives list.
         yaml_tag_directive_t *   end
 The end of the tag directives list.
      }   tag_directives
 The list of tag directives.
      int   implicit
 Is the document indicator implicit?
   }   document_start
 The document parameters (for YAML_DOCUMENT_START_EVENT).
   struct {
      int   implicit
 Is the document end indicator implicit?
   }   document_end
 The document end parameters (for YAML_DOCUMENT_END_EVENT).
   struct {
      yaml_char_t *   anchor
 The anchor.
   }   alias
 The alias parameters (for YAML_ALIAS_EVENT).
   struct {
      yaml_char_t *   anchor
 The anchor.
      yaml_char_t *   tag
 The tag.
      yaml_char_t *   value
 The scalar value.
      size_t   length
 The length of the scalar value.
      int   plain_implicit
 Is the tag optional for the plain style?
      int   quoted_implicit
 Is the tag optional for any non-plain style?
      yaml_scalar_style_t   style
 The scalar style.
   }   scalar
 The scalar parameters (for YAML_SCALAR_EVENT).
   struct {
      yaml_char_t *   anchor
 The anchor.
      yaml_char_t *   tag
 The tag.
      int   implicit
 Is the tag optional?
      yaml_sequence_style_t   style
 The sequence style.
   }   sequence_start
 The sequence parameters (for YAML_SEQUENCE_START_EVENT).
   struct {
      yaml_char_t *   anchor
 The anchor.
      yaml_char_t *   tag
 The tag.
      int   implicit
 Is the tag optional?
      yaml_mapping_style_t   style
 The mapping style.
   }   mapping_start
 The mapping parameters (for YAML_MAPPING_START_EVENT).
data
 The event data.
yaml_mark_t start_mark
 The beginning of the event.
yaml_mark_t end_mark
 The end of the event.

Detailed Description

The event structure.

Definition at line 384 of file yaml.h.


Field Documentation

struct { ... } yaml_event_s::alias

The alias parameters (for YAML_ALIAS_EVENT).

Referenced by parse(), yaml_emitter_analyze_event(), and yaml_parser_load_alias().

The anchor.

Definition at line 424 of file yaml.h.

union { ... } yaml_event_s::data

The document end parameters (for YAML_DOCUMENT_END_EVENT).

Referenced by yaml_emitter_emit_document_end().

The document parameters (for YAML_DOCUMENT_START_EVENT).

Referenced by parse(), yaml_emitter_emit_document_start(), and yaml_parser_load_document().

The document encoding.

Definition at line 395 of file yaml.h.

The end of the tag directives list.

Definition at line 408 of file yaml.h.

The end of the event.

Definition at line 474 of file yaml.h.

Referenced by yaml_parser_load_mapping(), yaml_parser_load_scalar(), and yaml_parser_load_sequence().

Is the document indicator implicit?

Is the tag optional?

Is the document end indicator implicit?

Definition at line 412 of file yaml.h.

The length of the scalar value.

Definition at line 436 of file yaml.h.

The mapping parameters (for YAML_MAPPING_START_EVENT).

Referenced by parse(), yaml_emitter_analyze_event(), yaml_emitter_emit_mapping_start(), and yaml_parser_load_mapping().

Is the tag optional for the plain style?

Definition at line 438 of file yaml.h.

Is the tag optional for any non-plain style?

Definition at line 440 of file yaml.h.

struct { ... } yaml_event_s::scalar

The scalar parameters (for YAML_SCALAR_EVENT).

Referenced by parse(), yaml_emitter_analyze_event(), yaml_emitter_select_scalar_style(), and yaml_parser_load_scalar().

The sequence parameters (for YAML_SEQUENCE_START_EVENT).

Referenced by parse(), yaml_emitter_analyze_event(), yaml_emitter_emit_sequence_start(), and yaml_parser_load_sequence().

The beginning of the tag directives list.

Definition at line 406 of file yaml.h.

The stream parameters (for YAML_STREAM_START_EVENT).

Referenced by parse().

The scalar style.

Definition at line 442 of file yaml.h.

The sequence style.

Definition at line 454 of file yaml.h.

The mapping style.

Definition at line 466 of file yaml.h.

The tag.

Definition at line 432 of file yaml.h.

The list of tag directives.

The scalar value.

Definition at line 434 of file yaml.h.

The version directive.

Definition at line 401 of file yaml.h.

Referenced by yaml_emitter_dump().


The documentation for this struct was generated from the following file: