class YAML::PullParser

Overview

A pull parser allows parsing a YAML document by events.

When creating an instance, the parser is positioned in the first event. To get the event kind invoke #kind. If the event is a scalar you can invoke #value to get its string value. Other methods like #tag, #anchor and #scalar_style let you inspect other information from events.

Invoking #read_next reads the next event.

Defined in:

yaml/pull_parser.cr

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.new(content : String | IO) #

[View source]
def self.new(content, &) #

Creates a parser, yields it to the block, and closes the parser at the end of it.


[View source]

Instance Method Detail

def anchor #

Returns the anchor associated to the current event, or nil if there's no anchor.


[View source]
def close #

[View source]
def end_column #

[View source]
def end_line #

[View source]
def expect_kind(kind : EventKind) #

Raises if the current kind is not the expected one.


[View source]
def finalize #

[View source]
def kind : EventKind #

The current event kind.


[View source]
def location #

[View source]
def mapping_style : MappingStyle #

Returns the mapping style, assuming the pull parser is located at a mapping begin event. Raises otherwise.


[View source]
def raise(msg : String, line_number = self.start_line, column_number = self.start_column, context_info = nil) #

[View source]
def read(expected_kind : EventKind) : EventKind #

Reads an expected event kind.


[View source]
def read_alias #

Reads an alias event, returning its anchor.


[View source]
def read_document(&) #

Reads a "document start" event, yields to the block, and then reads a "document end" event.


[View source]
def read_document_end #

Reads a "document end" event.


[View source]
def read_document_start #

Reads a "document start" event.


[View source]
def read_mapping(&) #

Reads a "mapping start" event, yields to the block, and then reads a "mapping end" event.


[View source]
def read_mapping_end #

Reads a "mapping end" event.


[View source]
def read_mapping_start #

Reads a "mapping start" event.


[View source]
def read_next : EventKind #

Reads the next event.


[View source]
def read_scalar #

Reads a scalar, returning its value.


[View source]
def read_sequence(&) #

Reads a "sequence start" event, yields to the block, and then reads a "sequence end" event.


[View source]
def read_sequence_end #

Reads a "sequence end" event.


[View source]
def read_sequence_start #

Reads a "sequence start" event.


[View source]
def read_stream(&) #

Reads a "stream start" event, yields to the block, and then reads a "stream end" event.


[View source]
def read_stream_end #

Reads a "stream end" event.


[View source]
def read_stream_start #

Reads a "stream start" event.


[View source]
def scalar_style : ScalarStyle #

Returns the scalar style, assuming the pull parser is located at a scalar event. Raises otherwise.


[View source]
def sequence_style : SequenceStyle #

Returns the sequence style, assuming the pull parser is located at a sequence begin event. Raises otherwise.


[View source]
def skip #

[View source]
def start_column #

[View source]
def start_line #

[View source]
def tag : String? #

Returns the tag associated to the current event, or nil if there's no tag.


[View source]
def value : String #

Returns the scalar value, assuming the pull parser is located at a scalar. Raises otherwise.


[View source]