?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 2.35 KB

/proc/thread-self/root/opt/alt/ruby27/share/ruby/psych/nodes.rb

Text Base64

# frozen_string_literal: true
require 'psych/nodes/node'
require 'psych/nodes/stream'
require 'psych/nodes/document'
require 'psych/nodes/sequence'
require 'psych/nodes/scalar'
require 'psych/nodes/mapping'
require 'psych/nodes/alias'

module Psych
  ###
  # = Overview
  #
  # When using Psych.load to deserialize a YAML document, the document is
  # translated to an intermediary AST.  That intermediary AST is then
  # translated in to a Ruby object graph.
  #
  # In the opposite direction, when using Psych.dump, the Ruby object graph is
  # translated to an intermediary AST which is then converted to a YAML
  # document.
  #
  # Psych::Nodes contains all of the classes that make up the nodes of a YAML
  # AST.  You can manually build an AST and use one of the visitors (see
  # Psych::Visitors) to convert that AST to either a YAML document or to a
  # Ruby object graph.
  #
  # Here is an example of building an AST that represents a list with one
  # scalar:
  #
  #   # Create our nodes
  #   stream = Psych::Nodes::Stream.new
  #   doc    = Psych::Nodes::Document.new
  #   seq    = Psych::Nodes::Sequence.new
  #   scalar = Psych::Nodes::Scalar.new('foo')
  #
  #   # Build up our tree
  #   stream.children << doc
  #   doc.children    << seq
  #   seq.children    << scalar
  #
  # The stream is the root of the tree.  We can then convert the tree to YAML:
  #
  #   stream.to_yaml => "---\n- foo\n"
  #
  # Or convert it to Ruby:
  #
  #   stream.to_ruby => [["foo"]]
  #
  # == YAML AST Requirements
  #
  # A valid YAML AST *must* have one Psych::Nodes::Stream at the root.  A
  # Psych::Nodes::Stream node must have 1 or more Psych::Nodes::Document nodes
  # as children.
  #
  # Psych::Nodes::Document nodes must have one and *only* one child.  That child
  # may be one of:
  #
  # * Psych::Nodes::Sequence
  # * Psych::Nodes::Mapping
  # * Psych::Nodes::Scalar
  #
  # Psych::Nodes::Sequence and Psych::Nodes::Mapping nodes may have many
  # children, but Psych::Nodes::Mapping nodes should have an even number of
  # children.
  #
  # All of these are valid children for Psych::Nodes::Sequence and
  # Psych::Nodes::Mapping nodes:
  #
  # * Psych::Nodes::Sequence
  # * Psych::Nodes::Mapping
  # * Psych::Nodes::Scalar
  # * Psych::Nodes::Alias
  #
  # Psych::Nodes::Scalar and Psych::Nodes::Alias are both terminal nodes and
  # should not have any children.
  module Nodes
  end
end

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
handlers DIR	-	drwxr-xr-x	2024-03-03 22:47:25	Edit Download recursive recursive
json DIR	-	drwxr-xr-x	2024-03-03 22:47:25	Edit Download recursive recursive
nodes DIR	-	drwxr-xr-x	2024-03-03 22:47:25	Edit Download recursive recursive
visitors DIR	-	drwxr-xr-x	2024-03-03 22:47:25	Edit Download recursive recursive
class_loader.rb	1.91 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
coder.rb	2.05 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
core_ext.rb	359 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
exception.rb	264 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
handler.rb	7.20 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
nodes.rb	2.35 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
omap.rb	75 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
parser.rb	1.67 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
scalar_scanner.rb	4.14 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
set.rb	74 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
stream.rb	923 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
streaming.rb	667 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
syntax_error.rb	585 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
tree_builder.rb	2.98 KB	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
versions.rb	222 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
visitors.rb	236 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive
y.rb	190 B	lrw-r--r--	2023-06-06 14:54:34	Edit Download recursive recursive

Directory Contents