class Psych::Nodes::Node (Ruby 3.4 リファレンスマニュアル)

要約

YAML AST のノードを表す抽象クラスです。

このクラスをインスタンス化することは不適切です。すべてのノードのクラスはこのクラスの派生クラスです。

継承しているメソッド

Enumerableから継承しているメソッド

インスタンスメソッド

alias? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Alias を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Alias ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Alias

children -> [Psych::Nodes::Node]Ruby 1.9.3 から[permalink][rdoc][edit]

子ノードの集合を配列で返します。

document? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Document を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Document ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Document

each -> EnumeratorRuby 1.9.3 から[permalink][rdoc][edit]

each {|node| ... } -> ()

self のノードをルートとする部分木の各ノードを引数としてブロックを呼び出します。

ブロックを省略した場合は Enumerator を返します。

end_column -> Integer | nilRuby 2.5.0 から[permalink][rdoc][edit]

end_column=(column)

self が表す YAML ドキュメント上の要素が終了する行内の位置(列番号)を返します。

Psych.parse などでパースして得られたノードには、パース時にこの位置情報が設定されます。手動で生成したノードでは nil のままです。

[PARAM] column:: 設定する終了位置の列番号

[SEE_ALSO] Psych::Nodes::Node#end_line, Psych::Nodes::Node#start_column

end_line -> Integer | nilRuby 2.5.0 から[permalink][rdoc][edit]

end_line=(line)

self が表す YAML ドキュメント上の要素が終了する行番号を返します。

Psych.parse などでパースして得られたノードには、パース時にこの位置情報が設定されます。手動で生成したノードでは nil のままです。

[PARAM] line:: 設定する終了行番号

[SEE_ALSO] Psych::Nodes::Node#end_column, Psych::Nodes::Node#start_line

mapping? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Mapping を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Mapping ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Mapping

scalar? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Scalar を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Scalar ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Scalar

sequence? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Sequence を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Sequence ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Sequence

start_column -> Integer | nilRuby 2.5.0 から[permalink][rdoc][edit]

start_column=(column)

self が表す YAML ドキュメント上の要素が開始する行内の位置(列番号)を返します。

Psych.parse などでパースして得られたノードには、パース時にこの位置情報が設定されます。手動で生成したノードでは nil のままです。

[PARAM] column:: 設定する開始位置の列番号

[SEE_ALSO] Psych::Nodes::Node#start_line, Psych::Nodes::Node#end_column

start_line -> Integer | nilRuby 2.5.0 から[permalink][rdoc][edit]

start_line=(line)

self が表す YAML ドキュメント上の要素が開始する行番号を返します。

Psych.parse などでパースして得られたノードには、パース時にこの位置情報が設定されます。手動で生成したノードでは nil のままです。

[PARAM] line:: 設定する開始行番号

[SEE_ALSO] Psych::Nodes::Node#start_column, Psych::Nodes::Node#end_line

stream? -> boolRuby 2.6.0 から[permalink][rdoc][edit]

self が Psych::Nodes::Stream を表すノードかどうかを返します。

Psych::Nodes::Node では常に false を返します。Psych::Nodes::Stream ではこのメソッドを override しており、常に true を返します。

[SEE_ALSO] Psych::Nodes::Stream

tag -> String | nilRuby 1.9.3 から[permalink][rdoc][edit]

ノードに付加されたタグを返します。

タグが付加されていない場合は nil を返します。

require 'psych'

ast = Psych.parse(<<EOS)
---
- !!str a
- b
EOS
  
p ast.root.children[0].value  # => "a"
p ast.root.children[0].tag    # => "tag:yaml.org,2002:str"
  
p ast.root.children[1].value  # => "b"
p ast.root.children[1].tag    # => nil

to_ruby -> objectRuby 1.9.3 から[permalink][rdoc][edit]

transform -> object

AST を ruby のオブジェクトに変換します。

yaml(io=nil, options={}) -> String | IORuby 1.9.3 から[permalink][rdoc][edit]

to_yaml(io=nil, options={}) -> String | IO

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、そのオブジェクトに変換後のドキュメントが書き込まれます。この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正であるためエラーが発生します。

options には以下が指定できます。

:version: YAML document に付加するバージョンを [major, minor] という配列、もしくは文字列で指定します
:header: 出力にヘッダを付けるかどうかを真偽値で指定します
:indentation: インデントのレベルを 1 から 9 までの整数で指定します
:canonical: 出力の style が canonical であるかどうかを真偽値で指定します
:line_width: 「好ましい」行幅を整数値で指定します

[PARAM] io:: 書き込み先の IO
[PARAM] options:: オプション

要約

目次

継承しているメソッド

インスタンスメソッド