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.crConstructors
- .new(content : String | IO)
- .new(content, &)
Creates a parser, yields it to the block, and closes the parser at the end of it.
Instance Method Summary
- #anchor : String?
Returns the anchor associated to the current event, or
nilif there's no anchor. - #close : Nil
- #end_column : Int32
- #end_line : Int32
- #expect_kind(kind : EventKind) : Nil
Raises if the current kind is not the expected one.
- #finalize
- #kind : EventKind
The current event kind.
- #location : Tuple(Int32, Int32)
- #mapping_style : MappingStyle
Returns the mapping style, assuming the pull parser is located at a mapping begin event.
- #raise(msg : String, line_number = self.start_line, column_number = self.start_column, context_info = nil) : NoReturn
- #read(expected_kind : EventKind) : EventKind
Reads an expected event kind.
- #read_alias : String?
Reads an alias event, returning its anchor.
- #read_document(&)
Reads a "document start" event, yields to the block, and then reads a "document end" event.
- #read_document_end
Reads a "document end" event.
- #read_document_start
Reads a "document start" event.
- #read_mapping(&)
Reads a "mapping start" event, yields to the block, and then reads a "mapping end" event.
- #read_mapping_end
Reads a "mapping end" event.
- #read_mapping_start
Reads a "mapping start" event.
- #read_next : EventKind
Reads the next event.
- #read_scalar : String
Reads a scalar, returning its value.
- #read_sequence(&)
Reads a "sequence start" event, yields to the block, and then reads a "sequence end" event.
- #read_sequence_end
Reads a "sequence end" event.
- #read_sequence_start
Reads a "sequence start" event.
- #read_stream(&)
Reads a "stream start" event, yields to the block, and then reads a "stream end" event.
- #read_stream_end
Reads a "stream end" event.
- #read_stream_start
Reads a "stream start" event.
- #scalar_style : ScalarStyle
Returns the scalar style, assuming the pull parser is located at a scalar event.
- #sequence_style : SequenceStyle
Returns the sequence style, assuming the pull parser is located at a sequence begin event.
- #skip : YAML::EventKind
- #start_column : Int32
- #start_line : Int32
- #tag : String?
Returns the tag associated to the current event, or
nilif there's no tag. - #value : String
Returns the scalar value, assuming the pull parser is located at a scalar.
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) : Bool
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(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, 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) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Constructor Detail
def self.new(content, &)Source
Creates a parser, yields it to the block, and closes the parser at the end of it.
Instance Method Detail
def anchor : String?Source
Returns the anchor associated to the current event, or nil if there's no anchor.
def finalizeSource
def mapping_style : MappingStyleSource
Returns the mapping style, assuming the pull parser is located at a mapping begin event. Raises otherwise.
def raise(msg : String, line_number = self.start_line, column_number = self.start_column, context_info = nil) : NoReturnSource
def read_document(&)Source
Reads a "document start" event, yields to the block, and then reads a "document end" event.
def read_document_endSource
Reads a "document end" event.
def read_document_startSource
Reads a "document start" event.
def read_mapping(&)Source
Reads a "mapping start" event, yields to the block, and then reads a "mapping end" event.
def read_mapping_endSource
Reads a "mapping end" event.
def read_mapping_startSource
Reads a "mapping start" event.
def read_sequence(&)Source
Reads a "sequence start" event, yields to the block, and then reads a "sequence end" event.
def read_sequence_endSource
Reads a "sequence end" event.
def read_sequence_startSource
Reads a "sequence start" event.
def read_stream(&)Source
Reads a "stream start" event, yields to the block, and then reads a "stream end" event.
def read_stream_endSource
Reads a "stream end" event.
def read_stream_startSource
Reads a "stream start" event.
def scalar_style : ScalarStyleSource
Returns the scalar style, assuming the pull parser is located at a scalar event. Raises otherwise.
def sequence_style : SequenceStyleSource
Returns the sequence style, assuming the pull parser is located at a sequence begin event. Raises otherwise.
def skip : YAML::EventKindSource
def value : StringSource
Returns the scalar value, assuming the pull parser is located at a scalar. Raises otherwise.
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/YAML/PullParser.html