Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • psych/lib/psych/tree_builder.rb

Psych::TreeBuilder

This class works in conjunction with Psych::Parser to build an in-memory parse tree that represents a YAML document.

Example ↑

parser = Psych::Parser.new Psych::TreeBuilder.new
parser.parse('--- foo')
tree = parser.handler.root

See Psych::Handler for documentation on the event methods used in this class.

Attributes

root[R]

Returns the root node for the built tree

Public Class Methods

new() click to toggle source

Create a new TreeBuilder instance

 
               # File psych/lib/psych/tree_builder.rb, line 21
def initialize
  @stack = []
  @last  = nil
  @root  = nil
end

Public Instance Methods

alias(anchor) click to toggle source 
 
               # File psych/lib/psych/tree_builder.rb, line 80
def alias anchor
  @last.children << Nodes::Alias.new(anchor)
end
end_document(implicit_end = !streaming?) click to toggle source

Handles #end_document events with version, tag_directives, and implicit styling.

See Psych::Handler#start_document

 
               # File psych/lib/psych/tree_builder.rb, line 60
def end_document implicit_end = !streaming?
  @last.implicit_end = implicit_end
  pop
end
end_stream() click to toggle source 
 
               # File psych/lib/psych/tree_builder.rb, line 70
def end_stream
  pop
end
scalar(value, anchor, tag, plain, quoted, style) click to toggle source 
 
               # File psych/lib/psych/tree_builder.rb, line 74
def scalar value, anchor, tag, plain, quoted, style
  s = Nodes::Scalar.new(value,anchor,tag,plain,quoted,style)
  @last.children << s
  s
end
start_document(version, tag_directives, implicit) click to toggle source

Handles #start_document events with version, tag_directives, and implicit styling.

See Psych::Handler#start_document

 
               # File psych/lib/psych/tree_builder.rb, line 49
def start_document version, tag_directives, implicit
  n = Nodes::Document.new version, tag_directives, implicit
  @last.children << n
  push n
end
start_stream(encoding) click to toggle source 
 
               # File psych/lib/psych/tree_builder.rb, line 65
def start_stream encoding
  @root = Nodes::Stream.new(encoding)
  push @root
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.