種類
- インスタンスメソッド (78)
- 定数 (22)
- 特異メソッド (22)
- クラス (10)
クラス
- Object (2)
-
Psych
:: Emitter (7) -
Psych
:: Handler (9) -
Psych
:: Nodes :: Alias (3) -
Psych
:: Nodes :: Document (9) -
Psych
:: Nodes :: Mapping (12) -
Psych
:: Nodes :: Node (4) -
Psych
:: Nodes :: Scalar (13) -
Psych
:: Nodes :: Sequence (9) -
Psych
:: Nodes :: Stream (7) -
Psych
:: Parser (4) -
Psych
:: Parser :: Mark (3) -
Psych
:: ScalarScanner (2) -
Psych
:: Stream (4) -
Psych
:: SyntaxError (6) -
Psych
:: TreeBuilder (2) -
Psych
:: Visitors :: YAMLTree (10)
キーワード
- << (1)
- ANY (5)
- Alias (1)
- BLOCK (2)
- BadAlias (1)
-
DOUBLE
_ QUOTED (1) - Emitter (1)
- Exception (1)
- FLOW (2)
- FOLDED (1)
-
LIBYAML
_ VERSION (1) - LITERAL (1)
- Mapping (1)
- PLAIN (1)
-
SINGLE
_ QUOTED (1) - Sequence (1)
- TreeBuilder (1)
- UTF16BE (2)
- UTF16LE (2)
- UTF8 (2)
- VERSION (1)
- Visitor (1)
- Visitors (1)
- YAMLTree (1)
- alias (1)
- anchor (4)
- anchor= (2)
- canonical (1)
- canonical= (1)
- children (1)
- column (2)
- context (1)
- dump (2)
-
dump
_ stream (1) - encoding (1)
- encoding= (1)
-
end
_ document (1) -
end
_ mapping (1) - file (1)
- finish (2)
- finished (1)
- finished? (1)
- implicit (3)
- implicit= (3)
-
implicit
_ end (1) -
implicit
_ end= (1) - indentation (1)
- indentation= (1)
- index (1)
-
libyaml
_ version (1) - line (2)
-
line
_ width (1) -
line
_ width= (1) - load (1)
-
load
_ file (1) -
load
_ stream (2) - new (10)
- offset (1)
- parse (1)
-
parse
_ file (1) -
parse
_ time (1) - plain (1)
- plain= (1)
- problem (1)
-
psych
_ to _ yaml (1) -
psych
_ y (1) - push (1)
- root (1)
-
safe
_ load (1) - scalar (1)
- start (3)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - started (1)
- started? (1)
- streaming? (1)
- style (3)
- style= (1)
- tag (4)
- tag= (1)
-
tag
_ directives (1) -
tag
_ directives= (1) -
to
_ json (1) -
to
_ yaml (2) - tokenize (1)
- tree (1)
- value (1)
- version (1)
- version= (1)
- y (1)
- yaml (1)
検索結果
先頭5件
-
Psych
:: Visitors :: YAMLTree # finish -> Psych :: Nodes :: Stream|nil (27307.0) -
変換を終了し、構築した AST を返します。
...変換を終了し、構築した AST を返します。
このメソッドは2回呼び出さないでください。
@see Psych::Visitors::YAMLTree#tree... -
Psych
:: Visitors :: YAMLTree # finished -> bool (27307.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # finished? -> bool (27307.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: Visitor (27007.0) -
Psych 内部で利用する、Visitor パターンのための 抽象クラス。
...Psych 内部で利用する、Visitor パターンのための 抽象クラス。... -
Psych
. load _ file(filename) -> object (18607.0) -
filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。
...filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。
@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (18607.0) -
filename で指定したファイルをパースして YAML の AST を返します。
...filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します... -
Psych
:: Emitter # indentation -> Integer (18607.0) -
インデントのレベルを返します。
...インデントのレベルを返します。
@see Psych::Emitter#indentation=... -
Psych
:: Emitter # line _ width -> Integer (18607.0) -
「好ましい」行幅を返します。
...「好ましい」行幅を返します。
@see Psych::Emitter#line_width=... -
Psych
:: Nodes :: Scalar :: PLAIN -> Integer (18607.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 (18607.0) -
single quoted style を表します。
...single quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar... -
Psych
:: Nodes :: Stream # encoding -> Integer (18607.0) -
stream に使われるエンコーディングを返します。
...stream に使われるエンコーディングを返します。
@see Psych::Nodes::Stream#encoding=... -
Psych
:: Parser :: Mark # index -> Integer (18607.0) -
先頭からの文字数。
先頭からの文字数。 -
Psych
:: Parser :: Mark # line -> Integer (18607.0) -
先頭からの行数。
先頭からの行数。 -
Psych
:: ScalarScanner # parse _ time(string) -> Time (18607.0) -
文字列を Time オブジェクトに変換します。
文字列を Time オブジェクトに変換します。
@param string 変換文字列 -
Psych
:: SyntaxError # file -> String|nil (18607.0) -
エラーが生じたファイルの名前を返します。
...エラーが生じたファイルの名前を返します。
Psych.load_file で指定したファイルの名前や
Psych.load の第2引数で指定した名前が返されます。
パース時にファイル名を指定しなかった場合は nil が返されます。... -
Psych
:: SyntaxError # line -> Integer (18607.0) -
エラーが生じた行番号を返します。
エラーが生じた行番号を返します。 -
Psych
. libyaml _ version -> [Integer , Integer , Integer] (18307.0) -
libyaml のバージョンを返します。
...libyaml のバージョンを返します。
[major, minor patch-level] という 3 つの整数からなる配列を返します。
@see Psych::LIBYAML_VERSION... -
Psych
:: Emitter # canonical -> bool (18307.0) -
出力の style が canonical であるならば真を返します。
...出力の style が canonical であるならば真を返します。
@see Psych::Emitter#canonical=... -
Psych
:: Emitter # canonical=(bool) (18307.0) -
出力の style が canonical である/ないを指定します。
...出力の style が canonical である/ないを指定します。
@param bool canonicalであるかどうか
@see Psych::Emitter#canonical... -
Psych
:: Emitter # indentation=(level) (18307.0) -
インデントのレベルを指定します。
...インデントのレベルを指定します。
1 から 9 までの整数で指定します。
@param level インデントレベル
@see Psych::Emitter#indentation... -
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
:: Handler # end _ mapping -> () (18307.0) -
mapping の終了の見付けたときに呼び出されます。
mapping の終了の見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (18307.0) -
mapping の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
* Psych::Nodes::Mapping::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられた... -
Psych
:: Handler # streaming? -> bool (18307.0) -
handler が streaming handler であるならば真を返すように override してください。
handler が streaming handler であるならば真を返すように
override してください。
デフォルトでは false を返します。 -
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 :: Document # tag _ directives -> [[String , String]] (18307.0) -
tag directive の配列を返します。
...tag directive の配列を返します。
@see Psych::Nodes::Document#tag_directives=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # tag _ directives=(tags) (18307.0) -
tag directive の配列を設定します。
...tag directive の配列を設定します。
@param tags 設定する tag directive の配列
@see Psych::Nodes::Document#tag_directives,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # version -> [Integer] (18307.0) -
YAML ドキュメントのバージョンを返します。
...YAML ドキュメントのバージョンを返します。
@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new... -
Psych
:: Nodes :: Document # version=(ver) (18307.0) -
YAML ドキュメントのバージョンを設定します。
...YAML ドキュメントのバージョンを設定します。
@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new... -
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 :: Node # children -> [Psych :: Nodes :: Node] (18307.0) -
子ノードの集合を配列で返します。
子ノードの集合を配列で返します。 -
Psych
:: Nodes :: Scalar # plain -> bool (18307.0) -
scalar が plain style であるかどうかを返します。
...scalar が plain style であるかどうかを返します。
@see Psych::Nodes::Scalar#plain=,
Psych::Nodes::Scalar.new... -
Psych
:: Nodes :: Scalar # plain=(bool) (18307.0) -
scalar が plain style であるかどうかを変更します。
...scalar が plain style であるかどうかを変更します。
@param bool 設定する真偽値
@see Psych::Nodes::Scalar#plain,
Psych::Nodes::Scalar.new... -
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 :: 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 :: Stream # encoding=(enc) (18307.0) -
stream に使われるエンコーディングを指定します。
...stream に使われるエンコーディングを指定します。
以下のいずれかを指定します。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE
@param enc 設定するエンコーディング
@see Psych::Nodes::Stream#encoding... -
Psych
:: ScalarScanner # tokenize(string) -> object (18307.0) -
YAML の scalar である文字列を Ruby のオブジェクトに変換した ものを返します。
...YAML の scalar である文字列を Ruby のオブジェクトに変換した
ものを返します。
scanner = Psych::ScalarScanner.new
p scanner.tokenize("yes") # => true
p scanner.tokenize("year") # => "year"
p scanner.tokenize("12") # => 12
@param string 変換文字列... -
Psych
:: Stream # finish -> () (18307.0) -
YAML document への変換を完了し、io への出力を完了します。
YAML document への変換を完了し、io への出力を完了します。 -
Psych
:: VERSION -> String (18307.0) -
Psych のバージョン。
...Psych のバージョン。... -
Psych
:: BadAlias (18007.0) -
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。
YAML の alias が不正である(本体が見つからない)というエラーを表す例外です。 -
Psych
:: Emitter (18007.0) -
Psych::Parser でパースし、生じたイベントから YAML ドキュメントを再構築するようなハンドラです。
...Psych::Parser でパースし、生じたイベントから
YAML ドキュメントを再構築するようなハンドラです。
以下の例では STDIN から YAML ドキュメントを入力し、
再構築した YAML ドキュメントを STDERR に出力します。
parser = Psych::Pars......w(Psych::Emitter.new($stderr))
parser.parse($stdin)
また、以下のようにイベントを手動で発生させることで
YAML ドキュメントを構築させることもできます。
各メソッドの意味については Psych::Handler を参照してください。
require 'psych'......put = StringIO.new
emitter = Psych::Emitter.new(output)
emitter.start_stream(Psych::Parser::UTF8)
emitter.start_document([1, 1], [], false)
emitter.start_mapping(nil, nil, false, Psych::Nodes::Mapping::BLOCK)
emitter.scalar("a", nil, nil, true, false, Psych::Nodes::Scalar::PLAIN)
emit... -
Psych
:: Exception (18007.0) -
Psych 関連のエラーを表す例外です。
...Psych 関連のエラーを表す例外です。... -
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 :: Mapping (18007.0) -
YAML の mapping http://yaml.org/spec/1.1/#mapping を表すクラスです。
...す。
Psych::Nodes::Mapping は 0 個以上の子ノードを持つことができます。
子ノードの個数は偶数でなければなりません。
子ノードは以下のいずれかクラスのインスタンスでなければなりません。
* Psych::Nodes::Sequence
* Psych::Node......s::Mapping
* Psych::Nodes::Scalar
* Psych::Nodes::Alias
子ノードは mapping のキーと値が交互に並んでいます。
ast = Psych.parse(<<EOS)
%YAML 1.1
---
x: y
u: v
EOS
p ast.root.children.map{|v| v.value } # => ["x", "y", "u", "v"]... -
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 (18007.0) -
Psych 内部で利用する各種 Visitor class を保持しているモジュール。
...Psych 内部で利用する各種 Visitor class を保持しているモジュール。... -
Psych
:: Nodes :: Mapping . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Mapping (9607.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
:: Emitter . new(io) -> Psych :: Emitter (9307.0) -
Emitter オブジェクトを生成して返します。
Emitter オブジェクトを生成して返します。
@param io 出力先の IO オブジェクト -
Psych
:: Nodes :: Alias # anchor -> String (9307.0) -
alias が指す先の anchor を返します。
...alias が指す先の 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 :: Mapping # anchor -> String|nil (9307.0) -
mapping に付加された anchor を返します。
...mapping に付加された anchor を返します。
@see Psych::Nodes::Mapping#anchor=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style -> Integer (9307.0) -
mapping の style を返します。
...mapping の style を返します。
@see Psych::Nodes::Mapping#style=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # tag -> String|nil (9307.0) -
mapping に付加された tag を返します。
...mapping に付加された tag を返します。
@see Psych::Nodes::Mapping#tag=,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping :: ANY -> Integer (9307.0) -
「任意」のスタイルを意味します。
...「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Mapping :: BLOCK -> Integer (9307.0) -
block style を表します。
...block style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: Nodes :: Mapping :: FLOW -> Integer (9307.0) -
flow style を表します。
...flow style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping... -
Psych
:: TreeBuilder . new -> Psych :: TreeBuilder (9307.0) -
TreeBuilder オブジェクトを生成します。
TreeBuilder オブジェクトを生成します。 -
Psych
:: Visitors :: YAMLTree # start(encoding = Nodes :: Stream :: UTF8) -> Psych :: Nodes :: Stream (9307.0) -
Ruby オブジェクトから YAML AST への変換のための準備をします。
...す。
Psych::Visitors::YAMLTree#push が呼び出されたとき、
まだこのメソッドが呼び出されていなければ push メソッドがこの
メソッドを呼び出し、変換の準備をします。
encoding には以下のいずれかを指定できます。
* Psych::Nodes::......Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE
@param encoding YAML AST に設定するエンコーディング... -
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 オブジェクト... -
Psych
:: Nodes :: Alias # anchor=(val) (9007.0) -
alias が指す先の anchor を変更します。
...alias が指す先の anchor を変更します。
@param val 設定する anchor
@see Psych::Nodes::Alias#anchor,
Psych::Nodes::Alias.new... -
Psych
:: Nodes :: Mapping # anchor=(a) (9007.0) -
mapping に付加する anchor を設定します。
...mapping に付加する anchor を設定します。
@param a 設定する anchor
@see Psych::Nodes::Mapping#anchor,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # style=(sty) (9007.0) -
mapping の style を設定します。
...mapping の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Mapping#style,
Psych::Nodes::Mapping.new... -
Psych
:: Nodes :: Mapping # tag=(t) (9007.0) -
mapping に付加する tag を設定します。
...mapping に付加する tag を設定します。
@param t 設定する tag
@see Psych::Nodes::Mapping#anchor=,
Psych::Nodes::Mapping.new... -
Psych
:: TreeBuilder # root -> Psych :: Nodes :: Stream (9007.0) -
AST の root を返します。
...AST の root を返します。
@see Psych::Nodes::Stream... -
Psych
:: Visitors :: YAMLTree (9007.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
:: Visitors :: YAMLTree # <<(object) (9007.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
Psych
:: Visitors :: YAMLTree # push(object) (9007.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
Psych
:: Visitors :: YAMLTree # started -> bool (9007.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Visitors :: YAMLTree # started? -> bool (9007.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
...Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。... -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (907.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (907.0) -
AST を YAML ドキュメントに変換します。
...返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が... -
Psych
. dump(o , io , options = {}) -> () (607.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(yaml , filename = nil , fallback = false) -> object (607.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 _ stream(yaml , filename=nil) -> [object] (607.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| . . . } -> () (607.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
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document (607.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
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object (607.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
:: Nodes :: Scalar . new(value , anchor=nil , tag=nil , plain=true , quoted=false , style=ANY) -> Psych :: Nodes:Scalar (607.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
:: Nodes :: Sequence . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Sequence (607.0) -
新たな sequence オブジェクトを生成します。
...ML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::Sequence::ANY
* Psych::Nodes::Sequence::BLOCK
* Psych::Nodes::Sequence::FLOW
@param anchor sequence に付加された anchor
@param tag sequence に付加された t... -
Kernel
# psych _ y(*objects) -> String (307.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Kernel
# y(*objects) -> String (307.0) -
objects を YAML document に変換します。
...のメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてくだ... -
Object
# psych _ to _ yaml(options = {}) -> String (307.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 (307.0) -
オブジェクトを YAML document に変換します。
...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。
syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予......定であるため、特別の事情がない限り to_yaml を用いてください。
@param options 出力オプション
@see Psych.dump... -
Psych
. dump(o , options = {}) -> String (307.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 _ stream(*objects) -> String (307.0) -
オブジェクト列を YAML ドキュメント列に変換します。
...オブジェクト列を YAML ドキュメント列に変換します。
@param objects 変換対象のオブジェクト列
//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//}... -
Psych
. to _ json(o) -> String (307.0) -
Ruby のオブジェクト o を JSON の文字列に変換します。
Ruby のオブジェクト o を JSON の文字列に変換します。
@param o 変換対象となるオブジェクト -
Psych
:: Handler # end _ document(implicit) -> () (307.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (307.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
:: Handler # start _ document(version , tag _ directives , implicit) -> () (307.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
Psych
:: Handler # start _ sequence(anchor , tag , implicit , style) -> () (307.0) -
sequence の開始を見付けたときに呼び出されます。
...偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Sequence::BLOCK
* Psych::Nodes::Sequence::FLOW
必要に応じてこのメソッドを override してください。
@param anchor 関連付けられ... -
Psych
:: Handler # start _ stream(encoding) -> () (307.0) -
YAML ストリームの始まりで呼び出されます。
...されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリーム... -
Psych
:: Nodes :: Document . new(version=[] , tag _ directives=[] , implicit=false) -> Psych :: Nodes :: Document (307.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...