Events

Data Structures
struct	yaml_event_t
	The event structure. More...
Enumerations
enum	yaml_event_type_t {   YAML_NO_EVENT,   YAML_STREAM_START_EVENT,   YAML_STREAM_END_EVENT,   YAML_DOCUMENT_START_EVENT,   YAML_DOCUMENT_END_EVENT,   YAML_ALIAS_EVENT,   YAML_SCALAR_EVENT,   YAML_SEQUENCE_START_EVENT,   YAML_SEQUENCE_END_EVENT,   YAML_MAPPING_START_EVENT,   YAML_MAPPING_END_EVENT }
	Event types.
Functions
int	yaml_stream_start_event_initialize (yaml_event_t *event, yaml_encoding_t encoding)
	Create the STREAM-START event.
int	yaml_stream_end_event_initialize (yaml_event_t *event)
	Create the STREAM-END event.
int	yaml_document_start_event_initialize (yaml_event_t *event, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int implicit)
	Create the DOCUMENT-START event.
int	yaml_document_end_event_initialize (yaml_event_t *event, int implicit)
	Create the DOCUMENT-END event.
int	yaml_alias_event_initialize (yaml_event_t *event, yaml_char_t *anchor)
	Create an ALIAS event.
int	yaml_scalar_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, yaml_char_t *value, int length, int plain_implicit, int quoted_implicit, yaml_scalar_style_t style)
	Create a SCALAR event.
int	yaml_sequence_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_sequence_style_t style)
	Create a SEQUENCE-START event.
int	yaml_sequence_end_event_initialize (yaml_event_t *event)
	Create a SEQUENCE-END event.
int	yaml_mapping_start_event_initialize (yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_mapping_style_t style)
	Create a MAPPING-START event.
int	yaml_mapping_end_event_initialize (yaml_event_t *event)
	Create a MAPPING-END event.
void	yaml_event_delete (yaml_event_t *event)
	Free any memory allocated for an event object.

---

Function Documentation

int yaml_stream_start_event_initialize (  yaml_event_t *  event, yaml_encoding_t  encoding )

Create the STREAM-START event. Parameters: [out]  event  An empty event object. [in]  encoding  The stream encoding. Returns: 1 if the function succeeded, 0 on error.

int yaml_stream_end_event_initialize (  yaml_event_t *  event  )

Create the STREAM-END event. Parameters: [out]  event  An empty event object. Returns: 1 if the function succeeded, 0 on error.

int yaml_document_start_event_initialize (  yaml_event_t *  event, yaml_version_directive_t *  version_directive, yaml_tag_directive_t *  tag_directives_start, yaml_tag_directive_t *  tag_directives_end, int  implicit )

Create the DOCUMENT-START event. The implicit argument is considered as a stylistic parameter and may be ignored by the emitter. Parameters: [out]  event  An empty event object. [in]  version_directive  The YAML directive value or NULL. [in]  tag_directives_start  The beginning of the TAG directives list. [in]  tag_directives_end  The end of the TAG directives list. [in]  implicit  If the document start indicator is implicit. Returns: 1 if the function succeeded, 0 on error.

int yaml_document_end_event_initialize (  yaml_event_t *  event, int  implicit )

Create the DOCUMENT-END event. The implicit argument is considered as a stylistic parameter and may be ignored by the emitter. Parameters: [out]  event  An empty event object. [in]  implicit  If the document end indicator is implicit. Returns: 1 if the function succeeded, 0 on error.

int yaml_alias_event_initialize (  yaml_event_t *  event, yaml_char_t *  anchor )

Create an ALIAS event. Parameters: [out]  event  An empty event object. [in]  anchor  The anchor value. Returns: 1 if the function succeeded, 0 on error.

int yaml_scalar_event_initialize (  yaml_event_t *  event, yaml_char_t *  anchor, yaml_char_t *  tag, yaml_char_t *  value, int  length, int  plain_implicit, int  quoted_implicit, yaml_scalar_style_t  style )

Create a SCALAR event. The style argument may be ignored by the emitter. Either the tag attribute or one of the plain_implicit and quoted_implicit flags must be set. Parameters: [out]  event  An empty event object. [in]  anchor  The scalar anchor or NULL. [in]  tag  The scalar tag or NULL. [in]  value  The scalar value. [in]  length  The length of the scalar value. [in]  plain_implicit  If the tag may be omitted for the plain style. [in]  quoted_implicit  If the tag may be omitted for any non-plain style. [in]  style  The scalar style. Returns: 1 if the function succeeded, 0 on error.

int yaml_sequence_start_event_initialize (  yaml_event_t *  event, yaml_char_t *  anchor, yaml_char_t *  tag, int  implicit, yaml_sequence_style_t  style )

Create a SEQUENCE-START event. The style argument may be ignored by the emitter. Either the tag attribute or the implicit flag must be set. Parameters: [out]  event  An empty event object. [in]  anchor  The sequence anchor or NULL. [in]  tag  The sequence tag or NULL. [in]  implicit  If the tag may be omitted. [in]  style  The sequence style. Returns: 1 if the function succeeded, 0 on error.

int yaml_sequence_end_event_initialize (  yaml_event_t *  event  )

Create a SEQUENCE-END event. Parameters: [out]  event  An empty event object. Returns: 1 if the function succeeded, 0 on error.

int yaml_mapping_start_event_initialize (  yaml_event_t *  event, yaml_char_t *  anchor, yaml_char_t *  tag, int  implicit, yaml_mapping_style_t  style )

Create a MAPPING-START event. The style argument may be ignored by the emitter. Either the tag attribute or the implicit flag must be set. Parameters: [out]  event  An empty event object. [in]  anchor  The mapping anchor or NULL. [in]  tag  The mapping tag or NULL. [in]  implicit  If the tag may be omitted. [in]  style  The mapping style. Returns: 1 if the function succeeded, 0 on error.

int yaml_mapping_end_event_initialize (  yaml_event_t *  event  )

Create a MAPPING-END event. Parameters: [out]  event  An empty event object. Returns: 1 if the function succeeded, 0 on error.

void yaml_event_delete (  yaml_event_t *  event  )

Free any memory allocated for an event object. Parameters: [out]  event  An event object.

---