yaml_event_s Struct Reference
[Events]

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().

yaml_char_t* yaml_event_s::anchor

The anchor.

Definition at line 460 of file yaml.h.

yaml_char_t* yaml_event_s::anchor

The anchor.

Definition at line 448 of file yaml.h.

yaml_char_t* yaml_event_s::anchor

The anchor.

Definition at line 430 of file yaml.h.

yaml_char_t* yaml_event_s::anchor

The anchor.

Definition at line 424 of file yaml.h.

union { ... } yaml_event_s::data

The event data.

Referenced by parse(), yaml_emitter_analyze_event(), yaml_emitter_emit_document_end(), yaml_emitter_emit_document_start(), yaml_emitter_emit_mapping_start(), yaml_emitter_emit_sequence_start(), yaml_emitter_emit_stream_start(), yaml_emitter_select_scalar_style(), yaml_parser_load_alias(), yaml_parser_load_document(), yaml_parser_load_mapping(), yaml_parser_load_scalar(), and yaml_parser_load_sequence().

struct { ... } yaml_event_s::document_end

The document end parameters (for YAML_DOCUMENT_END_EVENT).

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

struct { ... } yaml_event_s::document_start

The document parameters (for YAML_DOCUMENT_START_EVENT).

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

yaml_encoding_t yaml_event_s::encoding

The document encoding.

Definition at line 395 of file yaml.h.

yaml_tag_directive_t* yaml_event_s::end

The end of the tag directives list.

Definition at line 408 of file yaml.h.

yaml_mark_t yaml_event_s::end_mark

The end of the event.

Definition at line 474 of file yaml.h.

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

int yaml_event_s::implicit

Is the tag optional?

Definition at line 412 of file yaml.h.

size_t yaml_event_s::length

The length of the scalar value.

Definition at line 436 of file yaml.h.

struct { ... } yaml_event_s::mapping_start

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().

int yaml_event_s::plain_implicit

Is the tag optional for the plain style?

Definition at line 438 of file yaml.h.

int yaml_event_s::quoted_implicit

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().

struct { ... } yaml_event_s::sequence_start

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().

yaml_tag_directive_t* yaml_event_s::start

The beginning of the tag directives list.

Definition at line 406 of file yaml.h.

yaml_mark_t yaml_event_s::start_mark

The beginning of the event.

Definition at line 472 of file yaml.h.

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

struct { ... } yaml_event_s::stream_start

The stream parameters (for YAML_STREAM_START_EVENT).

Referenced by parse(), and yaml_emitter_emit_stream_start().

yaml_mapping_style_t yaml_event_s::style

The mapping style.

Definition at line 466 of file yaml.h.

yaml_sequence_style_t yaml_event_s::style

The sequence style.

Definition at line 454 of file yaml.h.

yaml_scalar_style_t yaml_event_s::style

The scalar style.

Definition at line 442 of file yaml.h.

yaml_char_t* yaml_event_s::tag

The tag.

Definition at line 462 of file yaml.h.

yaml_char_t* yaml_event_s::tag

The tag.

Definition at line 450 of file yaml.h.

yaml_char_t* yaml_event_s::tag

The tag.

Definition at line 432 of file yaml.h.

struct { ... } ::@61 yaml_event_s::tag_directives

The list of tag directives.

yaml_event_type_t yaml_event_s::type

The event type.

Definition at line 387 of file yaml.h.

Referenced by parse(), yaml_emitter_analyze_event(), yaml_emitter_check_empty_mapping(), yaml_emitter_check_empty_sequence(), yaml_emitter_check_simple_key(), yaml_emitter_emit_block_mapping_key(), yaml_emitter_emit_block_sequence_item(), yaml_emitter_emit_document_end(), yaml_emitter_emit_document_start(), yaml_emitter_emit_flow_mapping_key(), yaml_emitter_emit_flow_sequence_item(), yaml_emitter_emit_node(), yaml_emitter_emit_stream_start(), yaml_emitter_need_more_events(), yaml_parser_load(), yaml_parser_load_document(), yaml_parser_load_mapping(), yaml_parser_load_node(), and yaml_parser_load_sequence().

yaml_char_t* yaml_event_s::value

The scalar value.

Definition at line 434 of file yaml.h.

yaml_version_directive_t* yaml_event_s::version_directive

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:
Generated on 19 Jul 2016 for Ruby by  doxygen 1.4.7