種類
- インスタンスメソッド (78)
- 特異メソッド (22)
- 定数 (13)
- クラス (7)
クラス
- Module (2)
- Object (3)
-
Psych
:: Emitter (5) -
Psych
:: Handler (12) -
Psych
:: Nodes :: Alias (3) -
Psych
:: Nodes :: Document (5) -
Psych
:: Nodes :: Mapping (9) -
Psych
:: Nodes :: Node (4) -
Psych
:: Nodes :: Scalar (19) -
Psych
:: Nodes :: Sequence (9) -
Psych
:: Nodes :: Stream (1) -
Psych
:: Parser (5) -
Psych
:: Parser :: Mark (2) -
Psych
:: ScalarScanner (3) -
Psych
:: SyntaxError (4) -
Psych
:: TreeBuilder (2) -
Psych
:: Visitors :: YAMLTree (10)
キーワード
- << (1)
- ANY (1)
- Alias (1)
- BLOCK (2)
- BadAlias (1)
-
DOUBLE
_ QUOTED (1) - FLOW (2)
- FOLDED (1)
- Handler (1)
-
LIBYAML
_ VERSION (1) - LITERAL (1)
- PLAIN (1)
-
SINGLE
_ QUOTED (1) - Scalar (1)
- ScalarScanner (1)
- TreeBuilder (1)
- UTF16LE (2)
- YAMLTree (1)
- alias (1)
- anchor (4)
- anchor= (2)
- canonical (1)
- canonical= (1)
- children (1)
- column (2)
- empty (1)
-
end
_ document (1) -
end
_ mapping (1) -
end
_ sequence (1) -
end
_ stream (1) - file (1)
- finish (1)
- finished (1)
- finished? (1)
- handler (1)
- handler= (1)
- implicit (3)
- implicit= (3)
-
implicit
_ end (1) -
implicit
_ end= (1) - indentation= (1)
-
libyaml
_ version (1) - line (2)
-
line
_ width (1) -
line
_ width= (1) - load (1)
-
load
_ documents (2) -
load
_ file (1) -
load
_ stream (2) - new (9)
- parse (2)
-
parse
_ file (1) -
parse
_ stream (2) -
parse
_ time (1) - plain (1)
- plain= (1)
- problem (1)
-
psych
_ to _ yaml (1) -
psych
_ y (1) -
psych
_ yaml _ as (1) - push (1)
- quoted (1)
- quoted= (1)
- root (1)
-
safe
_ load (1) - scalar (1)
- start (1)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - started (1)
- started? (1)
- streaming? (1)
- style (3)
- style= (3)
- tag (4)
- tag= (1)
-
to
_ yaml (2) - tokenize (1)
- tree (1)
- value (1)
- value= (1)
- y (1)
- yaml (1)
-
yaml
_ as (1) -
yaml
_ tag (1)
検索結果
先頭5件
-
Psych
:: Nodes :: Scalar # plain -> bool (27307.0) -
scalar が plain style であるかどうかを返します。
...scalar が plain style であるかどうかを返します。
@see Psych::Nodes::Scalar#plain=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # plain=(bool) (27307.0) -
scalar が plain style であるかどうかを変更します。
...scalar が plain style であるかどうかを変更します。
@param bool 設定する真偽値
@see Psych::Nodes::Scalar#plain,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar :: PLAIN -> Integer (27307.0) -
plain scalar style を表します。
...plain scalar style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (18607.0) -
filename で指定したファイルをパースして YAML の AST を返します。
...filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
:: Emitter # canonical -> bool (18607.0) -
出力の style が canonical であるならば真を返します。
...出力の style が canonical であるならば真を返します。
@see Psych::Emitter#canonical=... -
Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (18607.0) -
スカラー値を見付けたときに呼び出されます。
...数値で渡されます。
style は次の値のいずれかです。
* Psych::Nodes::Scalar::PLAIN
* Psych::Nodes::Scalar::SINGLE_QUOTED
* Psych::Nodes::Scalar::DOUBLE_QUOTED
* Psych::Nodes::Scalar::LITERAL
* Psych::Nodes::Scalar::FOLDED
必要に応じてこのメソッドを override... -
Psych
:: Parser # handler -> Psych :: Handler (18607.0) -
セットされているイベントハンドラを返します。
...セットされているイベントハンドラを返します。
@see Psych::Parser#handler=... -
Module
# psych _ yaml _ as(tag) -> () (18307.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Module
# yaml _ as(tag) -> () (18307.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Object
# psych _ to _ yaml(options = {}) -> String (18307.0) -
オブジェクトを YAML document に変換します。
...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予......定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump... -
Object
# to _ yaml(options = {}) -> String (18307.0) -
オブジェクトを YAML document に変換します。
...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予......定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump... -
Object
. yaml _ tag(tag) -> () (18307.0) -
クラスと tag の間を関連付けます。
...g 対象のクラスに関連付けるタグの文字列
=== Example
require 'psych'
class Foo
def initialize(x)
@x = x
end
attr_reader :x
end
# Dumps Ruby object normally
p Psych.dump(Foo.new(3))
# =>
# --- !ruby/object:Foo
# x: 3
# Registers tag......yaml_as("tag:example.com,2013:foo")
# ... and dumps the object of Foo class
Psych.dump(Foo.new(3), STDOUT)
# =>
# --- !<tag:example.com,2013:foo>
# x: 3
# Loads the object from the tagged YAML node
p Psych.load(<<EOS)
--- !<tag:example.com,2012:foo>
x: 8
EOS
# => #<Foo:0x00... -
Psych
. libyaml _ version -> [Integer , Integer , Integer] (18307.0) -
libyaml のバージョンを返します。
...libyaml のバージョンを返します。
[major, minor patch-level] という 3 つの整数からなる配列を返します。
@see Psych::LIBYAML_VERSION... -
Psych
. load(yaml , filename = nil , fallback = false) -> object (18307.0) -
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
...IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@raise Psych::SyntaxError YAMLドキュメント......文法エラーが発見されたときに発生します
@see Psych.parse
//emlist[例][ruby]{
Psych.load("--- a") # => 'a'
Psych.load("---\n - a\n - b") # => ['a', 'b']
begin
Psych.load("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message... -
Psych
. load _ documents(yaml) -> [object] (18307.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。
...ジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたとき... -
Psych
. load _ documents(yaml) {|obj| . . . } -> () (18307.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。
...ジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたとき... -
Psych
. load _ file(filename) -> object (18307.0) -
filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。
...filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。
@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. load _ stream(yaml , filename=nil) -> [object] (18307.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
...を返します。
//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}
ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。
//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n.........に用います。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. load _ stream(yaml , filename=nil) {|obj| . . . } -> () (18307.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
...を返します。
//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}
ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。
//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n.........に用います。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object (18307.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
...[ruby]{
Psych.safe_load(yaml, [Date])
//}
すると上のクラス一覧に加えて Date クラスが読み込まれます。
エイリアスは aliases パラメーターを変更することで明示的に許可できます。
//emlist[例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_l......oad yaml # => 例外発生
Psych.safe_load yaml, [], [], true # => エイリアスが読み込まれる
//}
yaml にホワイトリストにないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生します。
yaml がエイリアスを含んでいて al......iases パラメーターが false の時、
Psych::BadAlias 例外が発生します。
filename はパース中に発生した例外のメッセージに用います。
キーワード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返しま... -
Psych
:: Emitter # canonical=(bool) (18307.0) -
出力の style が canonical である/ないを指定します。
...出力の style が canonical である/ないを指定します。
@param bool canonicalであるかどうか
@see Psych::Emitter#canonical... -
Psych
:: Emitter # line _ width -> Integer (18307.0) -
「好ましい」行幅を返します。
...「好ましい」行幅を返します。
@see Psych::Emitter#line_width=... -
Psych
:: Emitter # line _ width=(width) (18307.0) -
「好ましい」行幅を整数値で設定します。
...「好ましい」行幅を整数値で設定します。
@param width 好ましい行幅
@see Psych::Emitter#line_width... -
Psych
:: Handler # alias(anchor) -> () (18307.0) -
anchor という名前の alias を見付けたときに呼び出されます。
anchor という名前の alias を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。
@param anchor aliasのアンカー文字列
=== 例
以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。
--- &ponies
- first element
- *ponies
この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。 -
Psych
:: LIBYAML _ VERSION -> String (18307.0) -
libyaml のバージョン。
libyaml のバージョン。 -
Psych
:: Nodes :: Document # implicit -> bool (18307.0) -
ドキュメントが implicit に始まっているかどうかを返します。
...ドキュメントが implicit に始まっているかどうかを返します。
@see Psych::Nodes::Document#implicit=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # implicit=(bool) (18307.0) -
ドキュメントが implicit に始まっているかどうかを設定します。
...ドキュメントが implicit に始まっているかどうかを設定します。
@param bool ドキュメントが implicit に始まっているかどうかの設定値
@see Psych::Nodes::Document#implicit,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # implicit _ end -> bool (18307.0) -
ドキュメントが implicit に終わっているかどうかを返します。
...ドキュメントが implicit に終わっているかどうかを返します。
オブジェクト生成時のデフォルト値は true です。
@see Psych::Nodes::Document#implicit_end=... -
Psych
:: Nodes :: Document # implicit _ end=(bool) (18307.0) -
ドキュメントが implicit に終わっているかどうかを設定します。
...ドキュメントが implicit に終わっているかどうかを設定します。
@param bool ドキュメントが implicit に終わっているかどうかの設定値
@see Psych::Nodes::Document#implicit_end... -
Psych
:: Nodes :: Mapping # implicit -> bool (18307.0) -
mapping が implicit に開始されたかどうかを真偽値で返します。
...mapping が implicit に開始されたかどうかを真偽値で返します。
@see Psych::Nodes::Mapping#implicit=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # implicit=(bool) (18307.0) -
mapping が implicit に開始されたかどうかを真偽値で設定します。
...mapping が implicit に開始されたかどうかを真偽値で設定します。
@param bool 設定値
@see Psych::Nodes::Mapping#implicit,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style -> Integer (18307.0) -
mapping の style を返します。
...mapping の style を返します。
@see Psych::Nodes::Mapping#style=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style=(sty) (18307.0) -
mapping の style を設定します。
...mapping の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Mapping#style,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping :: BLOCK -> Integer (18307.0) -
block style を表します。
...block style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Mapping :: FLOW -> Integer (18307.0) -
flow style を表します。
...flow style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Node # children -> [Psych :: Nodes :: Node] (18307.0) -
子ノードの集合を配列で返します。
子ノードの集合を配列で返します。 -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (18307.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (18307.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
:: Nodes :: Scalar # style -> Integer (18307.0) -
scalar の style を返します。
...scalar の style を返します。
@see Psych::Nodes::Scalar#style=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # style=(sty) (18307.0) -
scalar の style を変更します。
...scalar の style を変更します。
@param sty 設定する style
@see Psych::Nodes::Scalar#style=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # value -> String (18307.0) -
scalar の値を返します。
...scalar の値を返します。
@see Psych::Nodes::Scalar#value=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # value=(v) (18307.0) -
scalar の値を設定します。
...scalar の値を設定します。
@param v 設定する値
@see Psych::Nodes::Scalar#value,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar :: DOUBLE _ QUOTED -> Integer (18307.0) -
double quoted style を表します。
...double quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: FOLDED -> Integer (18307.0) -
folded style を表します。
...folded style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: LITERAL -> Integer (18307.0) -
literal style を表します。
...literal style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: SINGLE _ QUOTED -> Integer (18307.0) -
single quoted style を表します。
...single quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Sequence # implicit -> bool (18307.0) -
sequence が implicit に開始されたかどうかを真偽値で返します。
...sequence が implicit に開始されたかどうかを真偽値で返します。
@see Psych::Nodes::Sequence#implicit=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # implicit=(bool) (18307.0) -
sequence が implicit に開始されたかどうかを真偽値で設定します。
...sequence が implicit に開始されたかどうかを真偽値で設定します。
@param bool 設定値
@see Psych::Nodes::Sequence#implicit,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # style -> Integer (18307.0) -
sequence の style を返します。
...sequence の style を返します。
@see Psych::Nodes::Sequence#style=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # style=(sty) (18307.0) -
sequence の style を設定します。
...sequence の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Sequence#style,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence :: BLOCK -> Integer (18307.0) -
block style を表します。
...block style を表します。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style,
Psych::Handler#start_sequence... -
Psych
:: Nodes :: Sequence :: FLOW -> Integer (18307.0) -
flow style を表します。
...flow style を表します。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style... -
Psych
:: Nodes :: Stream :: UTF16LE -> Integer (18307.0) -
UTF16LE エンコーディングを表します。
...UTF16LE エンコーディングを表します。
Psych::Parser::UTF16LE と同じ値です。
@see Psych::Nodes::Stream.new... -
Psych
:: Parser # handler=(val) (18307.0) -
イベントハンドラをセットします。
...イベントハンドラをセットします。
@param val セットするハンドラ
@see Psych::Parser#handler=... -
Psych
:: Parser :: Mark # column -> Integer (18307.0) -
行の先頭からの文字数。
行の先頭からの文字数。 -
Psych
:: Parser :: Mark # line -> Integer (18307.0) -
先頭からの行数。
先頭からの行数。 -
Psych
:: Parser :: UTF16LE -> Integer (18307.0) -
UTF-16LE エンコーディングを表します。
...UTF-16LE エンコーディングを表します。
@see Psych::Handler#start_stream... -
Psych
:: SyntaxError # column -> Integer (18307.0) -
エラーが生じた行内の位置を返します。
エラーが生じた行内の位置を返します。 -
Psych
:: SyntaxError # file -> String|nil (18307.0) -
エラーが生じたファイルの名前を返します。
...エラーが生じたファイルの名前を返します。
Psych.load_file で指定したファイルの名前や
Psych.load の第2引数で指定した名前が返されます。
パース時にファイル名を指定しなかった場合は nil が返されます。... -
Psych
:: SyntaxError # line -> Integer (18307.0) -
エラーが生じた行番号を返します。
エラーが生じた行番号を返します。 -
Psych
:: SyntaxError # problem -> String (18307.0) -
生じたエラーの中身を文字列で返します。
生じたエラーの中身を文字列で返します。 -
Psych
:: BadAlias (18007.0) -
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。 -
Psych
:: Handler (18007.0) -
Psych::Parser で用いるイベントハンドラの抽象基底クラスです。
...Psych::Parser で用いるイベントハンドラの抽象基底クラスです。
Psych::Parser を使うためには、このクラスを継承し、
取り扱いたいイベントに対応するメソッドを定義します。... -
Psych
:: Nodes :: Alias (18007.0) -
YAML の alias http://yaml.org/spec/1.1/#alias を表すクラス。
YAML の alias http://yaml.org/spec/1.1/#alias を表すクラス。
anchor で別の YAML の要素を指します。
alias は YAML の AST の葉のノードであり、子ノードを持ちません。 -
Psych
:: Nodes :: Scalar (18007.0) -
YAML の scalar http://yaml.org/spec/1.1/#id858081 を表すクラスです。
YAML の scalar http://yaml.org/spec/1.1/#id858081 を表すクラスです。
これは AST の葉にあたるノードであり、子ノードを持ちません。 -
Psych
:: ScalarScanner (18007.0) -
YAML の scalar 型を読み込んで Ruby の built-in 型に変換するクラス。
YAML の scalar 型を読み込んで Ruby の built-in 型に変換するクラス。 -
Psych
:: TreeBuilder (18007.0) -
YAML AST を構築するためのクラスです。
...す。
Psych::Parser.new に渡して YAML ドキュメントを YAML AST に変換する
ことができます。
また、Psych::Visitors::YAMLTree.new に渡して Ruby オブジェクト
を YAML AST に変換することもできます。
=== Example
parser = Psych::Parser.new Psych::Tree......Builder.new
parser.parse('--- foo')
parser.handler.root # => #<Psych::Nodes::Stream:0x00000001400000 ... >... -
Psych
:: Visitors :: YAMLTree (18007.0) -
Ruby オブジェクトから YAML の AST を構築するためのクラスです。
...クトから YAML の AST を構築するためのクラスです。
=== 例
builder = Psych::Visitors::YAMLTree.new
builder << { :foo => 'bar' }
builder << ["baz", "bazbaz"]
builder.tree # => #<Psych::Nodes::Stream ... > A stream containing two documents
puts tree.to_yaml
# =>
# ---... -
Psych
:: Handler # end _ document(implicit) -> () (9307.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
Psych
:: Handler # start _ document(version , tag _ directives , implicit) -> () (9307.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (9307.0) -
mapping の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
* Psych::Nodes::Mapping::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられた... -
Psych
:: Handler # start _ sequence(anchor , tag , implicit , style) -> () (9307.0) -
sequence の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Sequence::BLOCK
* Psych::Nodes::Sequence::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられ... -
Psych
:: Handler # streaming? -> bool (9307.0) -
handler が streaming handler であるならば真を返すように override してください。
handler が streaming handler であるならば真を返すように
override してください。
デフォルトでは false を返します。 -
Psych
:: Nodes :: Alias # anchor=(val) (9307.0) -
alias が指す先の anchor を変更します。
...alias が指す先の anchor を変更します。
@param val 設定する anchor
@see Psych::Nodes::Alias#anchor,
Psych::Nodes::Alias.new... -
Psych
:: Nodes :: Alias . new(anchor) -> Psych :: Nodes :: Alias (9307.0) -
新たな Alias オブジェクトを生成します。
新たな Alias オブジェクトを生成します。
anchor で指す先の anchor を指定します。
@param anchor 指す先の anchor -
Psych
:: Nodes :: Scalar # anchor -> String|nil (9307.0) -
scalar に付加された anchor を返します。
...scalar に付加された anchor を返します。
@see Psych::Nodes::Scalar#anchor=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # quoted -> bool (9307.0) -
scalar が quoted であるかどうかを返します。
...scalar が quoted であるかどうかを返します。
@see Psych::Nodes::Scalar#quoted=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # quoted=(bool) (9307.0) -
scalar が quoted であるかどうかを変更します。
...scalar が quoted であるかどうかを変更します。
@param bool 設定する真偽値
@see Psych::Nodes::Scalar#quoted,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # tag -> String|nil (9307.0) -
scalar に付加された tag を返します。
...scalar に付加された tag を返します。
@see Psych::Nodes::Scalar#tag=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar . new(value , anchor=nil , tag=nil , plain=true , quoted=false , style=ANY) -> Psych :: Nodes:Scalar (9307.0) -
Scalar オブジェクトを生成します。
...します。
style は次の値のいずれかです。
* Psych::Nodes::Scalar::ANY
* Psych::Nodes::Scalar::PLAIN
* Psych::Nodes::Scalar::SINGLE_QUOTED
* Psych::Nodes::Scalar::DOUBLE_QUOTED
* Psych::Nodes::Scalar::LITERAL
* Psych::Nodes::Scalar::FOLDED
@param value スカラー値
@para... -
Psych
:: TreeBuilder . new -> Psych :: TreeBuilder (9307.0) -
TreeBuilder オブジェクトを生成します。
TreeBuilder オブジェクトを生成します。 -
Psych
:: Visitors :: YAMLTree # finish -> Psych :: Nodes :: Stream|nil (9307.0) -
変換を終了し、構築した AST を返します。
...変換を終了し、構築した AST を返します。
このメソッドは2回呼び出さないでください。
@see Psych::Visitors::YAMLTree#tree... -
Psych
:: Visitors :: YAMLTree # finished -> bool (9307.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # finished? -> bool (9307.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # started -> bool (9307.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # started? -> bool (9307.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # tree -> Psych :: Nodes :: Stream|nil (9307.0) -
変換を終了し、構築した AST を返します。
...変換を終了し、構築した AST を返します。
内部で finish を呼び出し、変換処理を終了します。
このメソッドを2回以上呼ぶと、2回目以降は nil を返します。
@see Psych::Visitors::YAMLTree#finish... -
Psych
:: Visitors :: YAMLTree . new(options = {} , emitter = Psych :: TreeBuilder . new , ss = Psych :: ScalarScanner . new) -> Psych :: Visitors :: YAMLTree (9307.0) -
YAMLTree オブジェクトを生成します。
...定します。
Psych.dump と同じオプションが指定できます。
emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。
ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner......常デフォルトのものから変える必要はないでしょう。
@param options オプション
@param emitter AST の構築に使う Psych::TreeBuilder オブジェクト
@param ss 文字列に quite が必要かどうかを判定するための Psych::ScalarScanner オブジェクト... -
Kernel
# psych _ y(*objects) -> String (9007.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Kernel
# y(*objects) -> String (9007.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Psych
:: Handler # empty -> () (9007.0) -
empty event が発生したときに呼び出されます。
empty event が発生したときに呼び出されます。
実際問題としてこれが呼び出される例は知られていません。 -
Psych
:: Handler # end _ mapping -> () (9007.0) -
mapping の終了の見付けたときに呼び出されます。
mapping の終了の見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # end _ sequence -> () (9007.0) -
sequence の終了の見付けたときに呼び出されます。
sequence の終了の見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # end _ stream -> () (9007.0) -
YAML stream の終端を見付けたときに呼び出されます。
YAML stream の終端を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # start _ stream(encoding) -> () (9007.0) -
YAML ストリームの始まりで呼び出されます。
...されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリーム... -
Psych
:: Nodes :: Alias # anchor -> String (9007.0) -
alias が指す先の anchor を返します。
...alias が指す先の anchor を返します。
@see Psych::Nodes::Alias#anchor=,
Psych::Nodes::Alias.new... -
Psych
:: Nodes :: Scalar # anchor=(a) (9007.0) -
scalar に付加された anchor を変更します。
...scalar に付加された anchor を変更します。
@param a 設定する anchor
@see Psych::Nodes::Scalar#anchor,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # tag=(t) (9007.0) -
scalar に付加された tag を変更します。
...scalar に付加された tag を変更します。
@param t 設定する tag
@see Psych::Nodes::Scalar#tag,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar :: ANY -> Integer (9007.0) -
「任意」のスタイルを意味します。
...「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style... -
Psych
:: ScalarScanner # parse _ time(string) -> Time (9007.0) -
文字列を Time オブジェクトに変換します。
文字列を Time オブジェクトに変換します。
@param string 変換文字列