Ruby 2.0.0p247(2013-06-27revision41674)

- Main Page
- Modules
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Data Fields

Data Fields
yaml_token_s Struct Reference
Tokens

The token structure. More...

`#include <yaml.h>`

## Data Fields
yaml_token_type_t | type
| The token type. More...
union {
struct {
yaml_encoding_t encoding
| The stream encoding. More...
} stream_start
| The stream start (for `YAML_STREAM_START_TOKEN`). More...
struct {
yaml_char_t * value
| The alias value. More...
} alias
| The alias (for `YAML_ALIAS_TOKEN`). More...
struct {
yaml_char_t * value
| The anchor value. More...
} anchor
| The anchor (for `YAML_ANCHOR_TOKEN`). More...
struct {
yaml_char_t * handle
| The tag handle. More...
yaml_char_t * suffix
| The tag suffix. More...
} tag
| The tag (for `YAML_TAG_TOKEN`). More...
struct {
yaml_char_t * value
| The scalar value. More...
size_t length
| The length of the scalar value. More...
yaml_scalar_style_t style
| The scalar style. More...
} scalar
| The scalar value (for `YAML_SCALAR_TOKEN`). More...
struct {
int major
| The major version number. More...
int minor
| The minor version number. More...
} version_directive
| The version directive (for `YAML_VERSION_DIRECTIVE_TOKEN`). More...
struct {
yaml_char_t * handle
| The tag handle. More...
yaml_char_t * prefix
| The tag prefix. More...
} tag_directive
| The tag directive (for `YAML_TAG_DIRECTIVE_TOKEN`). More...
} | data
| The token data. More...
yaml_mark_t | start_mark
| The beginning of the token. More...
yaml_mark_t | end_mark
| The end of the token. More...

## Detailed Description

The token structure.

Definition at line 267 of file yaml.h.

## Field Documentation

struct { ... } yaml_token_s::alias

The alias (for `YAML_ALIAS_TOKEN`).

Referenced by yaml_parser_parse_node().

struct { ... } yaml_token_s::anchor

The anchor (for `YAML_ANCHOR_TOKEN`).

Referenced by yaml_parser_parse_node().

union { ... } yaml_token_s::data

The token data.

Referenced by yaml_parser_parse_node(), yaml_parser_parse_stream_start(), and yaml_parser_process_directives().

yaml_encoding_t yaml_token_s::encoding

The stream encoding.

Definition at line 278 of file yaml.h.

yaml_mark_t yaml_token_s::end_mark

The end of the token.

Definition at line 332 of file yaml.h.

Referenced by yaml_parser_parse_block_mapping_key(), yaml_parser_parse_block_mapping_value(), yaml_parser_parse_block_sequence_entry(), yaml_parser_parse_document_end(), yaml_parser_parse_document_start(), yaml_parser_parse_flow_mapping_key(), yaml_parser_parse_flow_sequence_entry(), yaml_parser_parse_flow_sequence_entry_mapping_key(), yaml_parser_parse_indentless_sequence_entry(), and yaml_parser_parse_node().

yaml_char_t* yaml_token_s::handle

The tag handle.

Definition at line 296 of file yaml.h.

size_t yaml_token_s::length

The length of the scalar value.

Definition at line 306 of file yaml.h.

int yaml_token_s::major

The major version number.

Definition at line 314 of file yaml.h.

int yaml_token_s::minor

The minor version number.

Definition at line 316 of file yaml.h.

yaml_char_t* yaml_token_s::prefix

The tag prefix.

Definition at line 324 of file yaml.h.

struct { ... } yaml_token_s::scalar

The scalar value (for `YAML_SCALAR_TOKEN`).

Referenced by yaml_parser_parse_node().

yaml_mark_t yaml_token_s::start_mark

The beginning of the token.

Definition at line 330 of file yaml.h.

Referenced by yaml_parser_parse_block_mapping_key(), yaml_parser_parse_block_mapping_value(), yaml_parser_parse_block_sequence_entry(), yaml_parser_parse_document_content(), yaml_parser_parse_document_end(), yaml_parser_parse_document_start(), yaml_parser_parse_flow_mapping_key(), yaml_parser_parse_flow_mapping_value(), yaml_parser_parse_flow_sequence_entry(), yaml_parser_parse_flow_sequence_entry_mapping_end(), yaml_parser_parse_flow_sequence_entry_mapping_value(), yaml_parser_parse_indentless_sequence_entry(), yaml_parser_parse_node(), yaml_parser_parse_stream_start(), and yaml_parser_process_directives().

struct { ... } yaml_token_s::stream_start

The stream start (for `YAML_STREAM_START_TOKEN`).

Referenced by yaml_parser_parse_stream_start().

yaml_scalar_style_t yaml_token_s::style

The scalar style.

Definition at line 308 of file yaml.h.

yaml_char_t* yaml_token_s::suffix

The tag suffix.

Definition at line 298 of file yaml.h.

struct { ... } yaml_token_s::tag

The tag (for `YAML_TAG_TOKEN`).

Referenced by yaml_parser_parse_node().

struct { ... } yaml_token_s::tag_directive

The tag directive (for `YAML_TAG_DIRECTIVE_TOKEN`).

Referenced by yaml_parser_process_directives().

yaml_token_type_t yaml_token_s::type

The token type.

Definition at line 270 of file yaml.h.

Referenced by yaml_parser_parse_block_mapping_key(), yaml_parser_parse_block_mapping_value(), yaml_parser_parse_block_sequence_entry(), yaml_parser_parse_document_content(), yaml_parser_parse_document_end(), yaml_parser_parse_document_start(), yaml_parser_parse_flow_mapping_key(), yaml_parser_parse_flow_mapping_value(), yaml_parser_parse_flow_sequence_entry(), yaml_parser_parse_flow_sequence_entry_mapping_key(), yaml_parser_parse_flow_sequence_entry_mapping_value(), yaml_parser_parse_indentless_sequence_entry(), yaml_parser_parse_node(), yaml_parser_parse_stream_start(), and yaml_parser_process_directives().

yaml_char_t* yaml_token_s::value

The alias value.

The scalar value.

The anchor value.

Definition at line 284 of file yaml.h.

struct { ... } yaml_token_s::version_directive

The version directive (for `YAML_VERSION_DIRECTIVE_TOKEN`).

Referenced by yaml_parser_process_directives().

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

- ext/psych/yaml/yaml.h