種類
- インスタンスメソッド (74)
- 特異メソッド (27)
- 定数 (18)
クラス
- Module (2)
- Object (3)
-
Psych
:: Emitter (7) -
Psych
:: Handler (7) -
Psych
:: Nodes :: Alias (3) -
Psych
:: Nodes :: Document (9) -
Psych
:: Nodes :: Mapping (12) -
Psych
:: Nodes :: Node (2) -
Psych
:: Nodes :: Scalar (19) -
Psych
:: Nodes :: Sequence (12) -
Psych
:: Nodes :: Stream (6) -
Psych
:: Parser (7) -
Psych
:: ScalarScanner (2) -
Psych
:: Stream (3) -
Psych
:: TreeBuilder (1) -
Psych
:: Visitors :: YAMLTree (6)
キーワード
- << (1)
- ANY (3)
- BLOCK (2)
-
DOUBLE
_ QUOTED (1) - FLOW (2)
- FOLDED (1)
- LITERAL (1)
- PLAIN (1)
-
SINGLE
_ QUOTED (1) - UTF16BE (2)
- UTF16LE (2)
- UTF8 (2)
- alias (1)
- anchor (4)
- anchor= (4)
- canonical (1)
- canonical= (1)
- dump (2)
-
dump
_ stream (1) - encoding (1)
- encoding= (1)
-
end
_ document (1) - finish (1)
- handler (1)
- handler= (1)
- implicit (3)
- implicit= (3)
-
implicit
_ end (1) -
implicit
_ end= (1) - indentation (1)
- indentation= (1)
-
libyaml
_ version (1) -
line
_ width (1) -
line
_ width= (1) - load (1)
-
load
_ documents (2) -
load
_ file (1) -
load
_ stream (2) - new (10)
- parse (2)
-
parse
_ file (1) -
parse
_ stream (2) -
parse
_ time (1) - plain (1)
- plain= (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 (3)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - style (3)
- style= (3)
- tag (3)
- tag= (3)
-
tag
_ directives (1) -
tag
_ directives= (1) -
to
_ json (1) -
to
_ yaml (2) - tokenize (1)
- tree (1)
- value (1)
- value= (1)
- version (1)
- version= (1)
- y (1)
- yaml (1)
-
yaml
_ as (1) -
yaml
_ tag (1)
検索結果
先頭5件
- Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () - Psych
:: Nodes :: Scalar . new(value , anchor=nil , tag=nil , plain=true , quoted=false , style=ANY) -> Psych :: Nodes:Scalar - Psych
. load(yaml , filename = nil , fallback = false) -> object - Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object - Psych
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document
-
Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (115.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
:: Nodes :: Scalar . new(value , anchor=nil , tag=nil , plain=true , quoted=false , style=ANY) -> Psych :: Nodes:Scalar (115.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
. load(yaml , filename = nil , fallback = false) -> object (97.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
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object (97.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
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document (79.0) -
YAML ドキュメントをパースし、YAML の AST を返します。
...用います。
AST については Psych::Nodes を参照してください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメント......に文法エラーが発見されたときに発生します
@see Psych.load
//emlist[例][ruby]{
Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:...>
begin
Psych.parse("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message # => "(file.txt... -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (79.0) -
mapping の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
* Psych::Nodes::Mapping::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられた... -
Psych
:: Handler # start _ sequence(anchor , tag , implicit , style) -> () (79.0) -
sequence の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Sequence::BLOCK
* Psych::Nodes::Sequence::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられ... -
Psych
:: Nodes :: Document . new(version=[] , tag _ directives=[] , implicit=false) -> Psych :: Nodes :: Document (79.0) -
Document オブジェクトを生成します。
...YAML 1.1 のドキュメントで、
tag directive を1つ持ち、 implicit にドキュメントが開始
している Document オブジェクトを生成しています。
Psych::Nodes::Document.new(
[1,1],
tenderlovemaking.com,2009:",
true)
@see Psych::Handler#start_document... -
Psych
:: Nodes :: Mapping . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Mapping (79.0) -
新たな mapping オブジェクトを生成します。
...AML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::Mapping::ANY
* Psych::Nodes::Mapping::BLOCK
* Psych::Nodes::Mapping::FLOW
@param anchor mapping に付加された anchor
@param tag mapping に付加された tag
@... -
Psych
:: Nodes :: Sequence . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Sequence (79.0) -
新たな sequence オブジェクトを生成します。
...ML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::Sequence::ANY
* Psych::Nodes::Sequence::BLOCK
* Psych::Nodes::Sequence::FLOW
@param anchor sequence に付加された anchor
@param tag sequence に付加された t... -
Object
. yaml _ tag(tag) -> () (61.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
. dump(o , io , options = {}) -> () (61.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
...[例][ruby]{
# Dump an array, get back a YAML string
Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
# Dump an array to an IO object
Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
# Dump an array with indentation set
Psych.dump(['a', ['b']], :indentation => 3) # => "---\n-......a\n- - b\n"
# Dump an array to an IO with indentation set
Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
//}... -
Psych
. dump(o , options = {}) -> String (61.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
...[例][ruby]{
# Dump an array, get back a YAML string
Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
# Dump an array to an IO object
Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
# Dump an array with indentation set
Psych.dump(['a', ['b']], :indentation => 3) # => "---\n-......a\n- - b\n"
# Dump an array to an IO with indentation set
Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
//}... -
Psych
. load _ stream(yaml , filename=nil) -> [object] (61.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| . . . } -> () (61.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
:: Handler # start _ document(version , tag _ directives , implicit) -> () (61.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
Psych
:: Visitors :: YAMLTree . new(options = {} , emitter = Psych :: TreeBuilder . new , ss = Psych :: ScalarScanner . new) -> Psych :: Visitors :: YAMLTree (61.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 オブジェクト... -
Object
# psych _ to _ yaml(options = {}) -> String (43.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 (43.0) -
オブジェクトを YAML document に変換します。
...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予......定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump... -
Psych
. load _ documents(yaml) -> [object] (43.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| . . . } -> () (43.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 (43.0) -
filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。
...filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。
@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (43.0) -
filename で指定したファイルをパースして YAML の AST を返します。
...filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
:: Emitter # canonical=(bool) (43.0) -
出力の style が canonical である/ないを指定します。
...出力の style が canonical である/ないを指定します。
@param bool canonicalであるかどうか
@see Psych::Emitter#canonical... -
Psych
:: Emitter # indentation=(level) (43.0) -
インデントのレベルを指定します。
...インデントのレベルを指定します。
1 から 9 までの整数で指定します。
@param level インデントレベル
@see Psych::Emitter#indentation... -
Psych
:: Emitter # line _ width=(width) (43.0) -
「好ましい」行幅を整数値で設定します。
...「好ましい」行幅を整数値で設定します。
@param width 好ましい行幅
@see Psych::Emitter#line_width... -
Psych
:: Nodes :: Alias # anchor=(val) (43.0) -
alias が指す先の anchor を変更します。
...alias が指す先の anchor を変更します。
@param val 設定する anchor
@see Psych::Nodes::Alias#anchor,
Psych::Nodes::Alias.new... -
Psych
:: Nodes :: Document # implicit=(bool) (43.0) -
ドキュメントが implicit に始まっているかどうかを設定します。
...ドキュメントが implicit に始まっているかどうかを設定します。
@param bool ドキュメントが implicit に始まっているかどうかの設定値
@see Psych::Nodes::Document#implicit,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # implicit _ end=(bool) (43.0) -
ドキュメントが implicit に終わっているかどうかを設定します。
...ドキュメントが implicit に終わっているかどうかを設定します。
@param bool ドキュメントが implicit に終わっているかどうかの設定値
@see Psych::Nodes::Document#implicit_end... -
Psych
:: Nodes :: Document # tag _ directives=(tags) (43.0) -
tag directive の配列を設定します。
...tag directive の配列を設定します。
@param tags 設定する tag directive の配列
@see Psych::Nodes::Document#tag_directives,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # version=(ver) (43.0) -
YAML ドキュメントのバージョンを設定します。
...YAML ドキュメントのバージョンを設定します。
@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Mapping # anchor=(a) (43.0) -
mapping に付加する anchor を設定します。
...mapping に付加する anchor を設定します。
@param a 設定する anchor
@see Psych::Nodes::Mapping#anchor,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # implicit=(bool) (43.0) -
mapping が implicit に開始されたかどうかを真偽値で設定します。
...mapping が implicit に開始されたかどうかを真偽値で設定します。
@param bool 設定値
@see Psych::Nodes::Mapping#implicit,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style=(sty) (43.0) -
mapping の style を設定します。
...mapping の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Mapping#style,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # tag=(t) (43.0) -
mapping に付加する tag を設定します。
...mapping に付加する tag を設定します。
@param t 設定する tag
@see Psych::Nodes::Mapping#anchor=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (43.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (43.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
:: Nodes :: Scalar # anchor=(a) (43.0) -
scalar に付加された anchor を変更します。
...scalar に付加された anchor を変更します。
@param a 設定する anchor
@see Psych::Nodes::Scalar#anchor,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # plain=(bool) (43.0) -
scalar が plain style であるかどうかを変更します。
...scalar が plain style であるかどうかを変更します。
@param bool 設定する真偽値
@see Psych::Nodes::Scalar#plain,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # quoted=(bool) (43.0) -
scalar が quoted であるかどうかを変更します。
...scalar が quoted であるかどうかを変更します。
@param bool 設定する真偽値
@see Psych::Nodes::Scalar#quoted,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # style=(sty) (43.0) -
scalar の style を変更します。
...scalar の style を変更します。
@param sty 設定する style
@see Psych::Nodes::Scalar#style=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # tag=(t) (43.0) -
scalar に付加された tag を変更します。
...scalar に付加された tag を変更します。
@param t 設定する tag
@see Psych::Nodes::Scalar#tag,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # value=(v) (43.0) -
scalar の値を設定します。
...scalar の値を設定します。
@param v 設定する値
@see Psych::Nodes::Scalar#value,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Sequence # anchor=(a) (43.0) -
sequence に付加する anchor を設定します。
...sequence に付加する anchor を設定します。
@param a 設定する anchor
@see Psych::Nodes::Sequence#anchor,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # implicit=(bool) (43.0) -
sequence が implicit に開始されたかどうかを真偽値で設定します。
...sequence が implicit に開始されたかどうかを真偽値で設定します。
@param bool 設定値
@see Psych::Nodes::Sequence#implicit,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # style=(sty) (43.0) -
sequence の style を設定します。
...sequence の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Sequence#style,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # tag=(t) (43.0) -
sequence に付加する tag を設定します。
...sequence に付加する tag を設定します。
@param t 設定する tag
@see Psych::Nodes::Sequence#anchor=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Stream # encoding=(enc) (43.0) -
stream に使われるエンコーディングを指定します。
...stream に使われるエンコーディングを指定します。
以下のいずれかを指定します。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE
@param enc 設定するエンコーディング
@see Psych::Nodes::Stream#encoding... -
Psych
:: Parser # handler=(val) (43.0) -
イベントハンドラをセットします。
...イベントハンドラをセットします。
@param val セットするハンドラ
@see Psych::Parser#handler=... -
Kernel
# psych _ y(*objects) -> String (25.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Kernel
# y(*objects) -> String (25.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Module
# psych _ yaml _ as(tag) -> () (25.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Module
# yaml _ as(tag) -> () (25.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Psych
. dump _ stream(*objects) -> String (25.0) -
オブジェクト列を YAML ドキュメント列に変換します。
...オブジェクト列を YAML ドキュメント列に変換します。
@param objects 変換対象のオブジェクト列
//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//}... -
Psych
. libyaml _ version -> [Integer , Integer , Integer] (25.0) -
libyaml のバージョンを返します。
...libyaml のバージョンを返します。
[major, minor patch-level] という 3 つの整数からなる配列を返します。
@see Psych::LIBYAML_VERSION... -
Psych
. parse _ stream(yaml) -> Psych :: Nodes :: Stream (25.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
...した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes......//emlist[例][ruby]{
Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
//}... -
Psych
. parse _ stream(yaml) {|node| . . . } -> () (25.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
...した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes......//emlist[例][ruby]{
Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
//}... -
Psych
. to _ json(o) -> String (25.0) -
Ruby のオブジェクト o を JSON の文字列に変換します。
Ruby のオブジェクト o を JSON の文字列に変換します。
@param o 変換対象となるオブジェクト -
Psych
:: Emitter # canonical -> bool (25.0) -
出力の style が canonical であるならば真を返します。
...出力の style が canonical であるならば真を返します。
@see Psych::Emitter#canonical=... -
Psych
:: Emitter # indentation -> Integer (25.0) -
インデントのレベルを返します。
...インデントのレベルを返します。
@see Psych::Emitter#indentation=... -
Psych
:: Emitter # line _ width -> Integer (25.0) -
「好ましい」行幅を返します。
...「好ましい」行幅を返します。
@see Psych::Emitter#line_width=... -
Psych
:: Emitter . new(io) -> Psych :: Emitter (25.0) -
Emitter オブジェクトを生成して返します。
Emitter オブジェクトを生成して返します。
@param io 出力先の IO オブジェクト -
Psych
:: Handler # alias(anchor) -> () (25.0) -
anchor という名前の alias を見付けたときに呼び出されます。
anchor という名前の alias を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。
@param anchor aliasのアンカー文字列
=== 例
以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。
--- &ponies
- first element
- *ponies
この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。 -
Psych
:: Handler # end _ document(implicit) -> () (25.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
Psych
:: Handler # start _ stream(encoding) -> () (25.0) -
YAML ストリームの始まりで呼び出されます。
...されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリーム... -
Psych
:: Nodes :: Alias # anchor -> String (25.0) -
alias が指す先の anchor を返します。
...alias が指す先の anchor を返します。
@see Psych::Nodes::Alias#anchor=,
Psych::Nodes::Alias.new... -
Psych
:: Nodes :: Alias . new(anchor) -> Psych :: Nodes :: Alias (25.0) -
新たな Alias オブジェクトを生成します。
新たな Alias オブジェクトを生成します。
anchor で指す先の anchor を指定します。
@param anchor 指す先の anchor -
Psych
:: Nodes :: Document # implicit -> bool (25.0) -
ドキュメントが implicit に始まっているかどうかを返します。
...ドキュメントが implicit に始まっているかどうかを返します。
@see Psych::Nodes::Document#implicit=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # implicit _ end -> bool (25.0) -
ドキュメントが implicit に終わっているかどうかを返します。
...ドキュメントが implicit に終わっているかどうかを返します。
オブジェクト生成時のデフォルト値は true です。
@see Psych::Nodes::Document#implicit_end=... -
Psych
:: Nodes :: Document # tag _ directives -> [[String , String]] (25.0) -
tag directive の配列を返します。
...tag directive の配列を返します。
@see Psych::Nodes::Document#tag_directives=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # version -> [Integer] (25.0) -
YAML ドキュメントのバージョンを返します。
...YAML ドキュメントのバージョンを返します。
@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Mapping # anchor -> String|nil (25.0) -
mapping に付加された anchor を返します。
...mapping に付加された anchor を返します。
@see Psych::Nodes::Mapping#anchor=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # implicit -> bool (25.0) -
mapping が implicit に開始されたかどうかを真偽値で返します。
...mapping が implicit に開始されたかどうかを真偽値で返します。
@see Psych::Nodes::Mapping#implicit=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style -> Integer (25.0) -
mapping の style を返します。
...mapping の style を返します。
@see Psych::Nodes::Mapping#style=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # tag -> String|nil (25.0) -
mapping に付加された tag を返します。
...mapping に付加された tag を返します。
@see Psych::Nodes::Mapping#tag=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping :: ANY -> Integer (25.0) -
「任意」のスタイルを意味します。
...「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Mapping :: BLOCK -> Integer (25.0) -
block style を表します。
...block style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Mapping :: FLOW -> Integer (25.0) -
flow style を表します。
...flow style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Scalar # anchor -> String|nil (25.0) -
scalar に付加された anchor を返します。
...scalar に付加された anchor を返します。
@see Psych::Nodes::Scalar#anchor=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # plain -> bool (25.0) -
scalar が plain style であるかどうかを返します。
...scalar が plain style であるかどうかを返します。
@see Psych::Nodes::Scalar#plain=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # quoted -> bool (25.0) -
scalar が quoted であるかどうかを返します。
...scalar が quoted であるかどうかを返します。
@see Psych::Nodes::Scalar#quoted=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # style -> Integer (25.0) -
scalar の style を返します。
...scalar の style を返します。
@see Psych::Nodes::Scalar#style=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # tag -> String|nil (25.0) -
scalar に付加された tag を返します。
...scalar に付加された tag を返します。
@see Psych::Nodes::Scalar#tag=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # value -> String (25.0) -
scalar の値を返します。
...scalar の値を返します。
@see Psych::Nodes::Scalar#value=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar :: ANY -> Integer (25.0) -
「任意」のスタイルを意味します。
...「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style... -
Psych
:: Nodes :: Scalar :: DOUBLE _ QUOTED -> Integer (25.0) -
double quoted style を表します。
...double quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: FOLDED -> Integer (25.0) -
folded style を表します。
...folded style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: LITERAL -> Integer (25.0) -
literal style を表します。
...literal style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: PLAIN -> Integer (25.0) -
plain scalar style を表します。
...plain scalar style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Scalar :: SINGLE _ QUOTED -> Integer (25.0) -
single quoted style を表します。
...single quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Sequence # anchor -> String|nil (25.0) -
sequence に付加された anchor を返します。
...sequence に付加された anchor を返します。
@see Psych::Nodes::Sequence#anchor=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # implicit -> bool (25.0) -
sequence が implicit に開始されたかどうかを真偽値で返します。
...sequence が implicit に開始されたかどうかを真偽値で返します。
@see Psych::Nodes::Sequence#implicit=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # style -> Integer (25.0) -
sequence の style を返します。
...sequence の style を返します。
@see Psych::Nodes::Sequence#style=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence # tag -> String|nil (25.0) -
sequence に付加された tag を返します。
...sequence に付加された tag を返します。
@see Psych::Nodes::Sequence#tag=,
Psych::Nodes::Sequence.new... -
Psych
:: Nodes :: Sequence :: ANY -> Integer (25.0) -
「任意」のスタイルを意味します。
...「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style,
Psych::Handler#start_sequence... -
Psych
:: Nodes :: Sequence :: BLOCK -> Integer (25.0) -
block style を表します。
...block style を表します。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style,
Psych::Handler#start_sequence... -
Psych
:: Nodes :: Sequence :: FLOW -> Integer (25.0) -
flow style を表します。
...flow style を表します。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style... -
Psych
:: Nodes :: Stream # encoding -> Integer (25.0) -
stream に使われるエンコーディングを返します。
...stream に使われるエンコーディングを返します。
@see Psych::Nodes::Stream#encoding=... -
Psych
:: Nodes :: Stream . new(encoding = Psych :: Nodes :: Stream :: UTF8) -> Psych :: Nodes :: Stream (25.0) -
Psych::Nodes::Stream オブジェクトを生成して返します。
...
Psych::Nodes::Stream オブジェクトを生成して返します。
encoding には stream に使われるエンコーディングを指定します。
以下のいずれかを指定します。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE
@param... -
Psych
:: Nodes :: Stream :: UTF16BE -> Integer (25.0) -
UTF16BE エンコーディングを表します。
...UTF16BE エンコーディングを表します。
Psych::Parser::UTF16BE と同じ値です。
@see Psych::Nodes::Stream.new...