In Files

  • psych/lib/psych/nodes/sequence.rb
  • psych/lib/psych/visitors/yaml_tree.rb

Methods

Psych::Nodes::Sequence

This class represents a YAML sequence.

A YAML sequence is basically a list, and looks like this:

%YAML 1.1
---
- I am
- a Sequence

A YAML sequence may have an anchor like this:

%YAML 1.1
---
&A [
  "This sequence",
  "has an anchor"
]

A YAML sequence may also have a tag like this:

%YAML 1.1
---
!!seq [
  "This sequence",
  "has a tag"
]

This class represents a sequence in a YAML document. A Psych::Nodes::Sequence node may have 0 or more children. Valid children for this node are:

Constants

ANY

Any Styles, emitter chooses

BLOCK

Block style sequence

FLOW

Flow style sequence

Attributes

anchor[RW]

The anchor for this sequence (if any)

implicit[RW]

Is this sequence started implicitly?

style[RW]

The sequece style used

tag[RW]

The tag name for this sequence (if any)

Public Class Methods

new(anchor = nil, tag = nil, implicit = true, style = BLOCK) click to toggle source

Create a new object representing a YAML sequence.

anchor is the anchor associated with the sequence or nil. tag is the tag associated with the sequence or nil. implicit a boolean indicating whether or not the sequence was implicitly started. style is an integer indicating the list style.

See Psych::Handler#start_sequence

 
               # File psych/lib/psych/nodes/sequence.rb, line 72
def initialize anchor = nil, tag = nil, implicit = true, style = BLOCK
  super()
  @anchor   = anchor
  @tag      = tag
  @implicit = implicit
  @style    = style
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.

blog comments powered by Disqus