種類
- インスタンスメソッド (14)
- 定数 (13)
- クラス (3)
- 特異メソッド (1)
ライブラリ
- psych (31)
クラス
-
Psych
:: Handler (12) -
Psych
:: Nodes :: Document (1) -
Psych
:: Nodes :: Mapping (3) -
Psych
:: Nodes :: Scalar (5) -
Psych
:: Nodes :: Sequence (2) -
Psych
:: Parser (5)
キーワード
- ANY (2)
- BLOCK (2)
-
DOUBLE
_ QUOTED (1) - Emitter (1)
- FLOW (1)
- FOLDED (1)
- Handler (1)
- LITERAL (1)
- PLAIN (1)
- Parser (1)
-
SINGLE
_ QUOTED (1) - UTF16BE (1)
- UTF16LE (1)
- UTF8 (1)
- alias (1)
- empty (1)
-
end
_ document (1) -
end
_ mapping (1) -
end
_ sequence (1) -
end
_ stream (1) - handler (1)
- new (1)
- parse (1)
- scalar (1)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - streaming? (1)
検索結果
先頭5件
-
Psych
:: Handler (69001.0) -
Psych::Parser で用いるイベントハンドラの抽象基底クラスです。
Psych::Parser で用いるイベントハンドラの抽象基底クラスです。
Psych::Parser を使うためには、このクラスを継承し、
取り扱いたいイベントに対応するメソッドを定義します。 -
Psych
:: Handler # alias(anchor) -> () (63001.0) -
anchor という名前の alias を見付けたときに呼び出されます。
anchor という名前の alias を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。
@param anchor aliasのアンカー文字列
=== 例
以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。
--- &ponies
- first element
- *ponies
この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。 -
Psych
:: Handler # empty -> () (63001.0) -
empty event が発生したときに呼び出されます。
empty event が発生したときに呼び出されます。
実際問題としてこれが呼び出される例は知られていません。 -
Psych
:: Handler # end _ document(implicit) -> () (63001.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
Psych
:: Handler # end _ mapping -> () (63001.0) -
mapping の終了の見付けたときに呼び出されます。
mapping の終了の見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # end _ sequence -> () (63001.0) -
sequence の終了の見付けたときに呼び出されます。
sequence の終了の見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # end _ stream -> () (63001.0) -
YAML stream の終端を見付けたときに呼び出されます。
YAML stream の終端を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (63001.0) -
スカラー値を見付けたときに呼び出されます。
スカラー値を見付けたときに呼び出されます。
value にはスカラー値の文字列が渡されます。
anchor にはスカラー値に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag にはスカラー値に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
plain は plain style であるかどうか、quoted は quoted style であるかどうか
が渡されます。style には node の style が整数値で渡されます。
style は次の値のいずれか... -
Psych
:: Handler # start _ document(version , tag _ directives , implicit) -> () (63001.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) -> () (63001.0) -
mapping の開始を見付けたときに呼び出されます。
mapping の開始を見付けたときに呼び出されます。
anchor には map に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には map に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には map が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
... -
Psych
:: Handler # start _ sequence(anchor , tag , implicit , style) -> () (63001.0) -
sequence の開始を見付けたときに呼び出されます。
sequence の開始を見付けたときに呼び出されます。
anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には sequence が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:... -
Psych
:: Handler # start _ stream(encoding) -> () (63001.0) -
YAML ストリームの始まりで呼び出されます。
YAML ストリームの始まりで呼び出されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。
必要に応じてこのメソッドを override してください。
@param encoding ストリームのエンコーディング(整数値) -
Psych
:: Handler # streaming? -> bool (63001.0) -
handler が streaming handler であるならば真を返すように override してください。
handler が streaming handler であるならば真を返すように
override してください。
デフォルトでは false を返します。 -
Psych
:: Parser # handler -> Psych :: Handler (304.0) -
セットされているイベントハンドラを返します。
セットされているイベントハンドラを返します。
@see Psych::Parser#handler= -
Psych
:: Parser (37.0) -
YAML のパーサ。
YAML のパーサ。
このクラスは YAML ドキュメントをパースし、コンストラクタに渡された
ハンドラにイベントを通知(呼び出し)します。
このイベントを使って YAML の AST を構築したり YAML ドキュメントを
別のフォーマット変換したりします。
Psych::Emitter を使うとパースしたドキュメントを元通りに出力
することもできます。
Psych::Parser が生成するイベントは Psych::Handler
を見てください。
以下の例では YAML ドキュメント に含まれているスカラー値を表示します。
# Handler for detecting s... -
Psych
:: Emitter (19.0) -
Psych::Parser でパースし、生じたイベントから YAML ドキュメントを再構築するようなハンドラです。
Psych::Parser でパースし、生じたイベントから
YAML ドキュメントを再構築するようなハンドラです。
以下の例では STDIN から YAML ドキュメントを入力し、
再構築した YAML ドキュメントを STDERR に出力します。
parser = Psych::Parser.new(Psych::Emitter.new($stderr))
parser.parse($stdin)
また、以下のようにイベントを手動で発生させることで
YAML ドキュメントを構築させることもできます。
各メソッドの意味については Psych::Handler を参照してください... -
Psych
:: Nodes :: Document . new(version=[] , tag _ directives=[] , implicit=false) -> Psych :: Nodes :: Document (19.0) -
Document オブジェクトを生成します。
Document オブジェクトを生成します。
version にはドキュメントのバージョンを指定します。
[major, minor] という配列で指定します。
tag_directives には tag directive の配列を指定します。
それぞれの tag は [prefix, suffix] という文字列の配列で
表現します。
implicit にはドキュメントが implicit に始まっているかどうかを
真偽値で指定します。
@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列... -
Psych
:: Nodes :: Mapping :: ANY -> Integer (19.0) -
「任意」のスタイルを意味します。
「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping -
Psych
:: Nodes :: Mapping :: BLOCK -> Integer (19.0) -
block style を表します。
block style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping -
Psych
:: Nodes :: Mapping :: FLOW -> Integer (19.0) -
flow style を表します。
flow style を表します。
@see Psych::Nodes::Mapping.new,
Psych::Nodes::Mapping#style,
Psych::Handler#start_mapping -
Psych
:: Nodes :: Scalar :: DOUBLE _ QUOTED -> Integer (19.0) -
double quoted style を表します。
double quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar -
Psych
:: Nodes :: Scalar :: FOLDED -> Integer (19.0) -
folded style を表します。
folded style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar -
Psych
:: Nodes :: Scalar :: LITERAL -> Integer (19.0) -
literal style を表します。
literal style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar -
Psych
:: Nodes :: Scalar :: PLAIN -> Integer (19.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 (19.0) -
single quoted style を表します。
single quoted style を表します。
@see Psych::Nodes::Scalar.new,
Psych::Nodes::Scalar#style,
Psych::Handler#scalar -
Psych
:: Nodes :: Sequence :: ANY -> Integer (19.0) -
「任意」のスタイルを意味します。
「任意」のスタイルを意味します。
emitter が適当に style を決めます。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style,
Psych::Handler#start_sequence -
Psych
:: Nodes :: Sequence :: BLOCK -> Integer (19.0) -
block style を表します。
block style を表します。
@see Psych::Nodes::Sequence.new,
Psych::Nodes::Sequence#style,
Psych::Handler#start_sequence -
Psych
:: Parser # parse(yaml) -> self (19.0) -
YAML ドキュメントをパースし、イベントハンドラに イベントを逐次通知します。
YAML ドキュメントをパースし、イベントハンドラに
イベントを逐次通知します。
@see Psych::Parser.new, Psych::Handler, Psych::Parser#handler -
Psych
:: Parser :: UTF16BE -> Integer (19.0) -
UTF-16BE エンコーディングを表します。
UTF-16BE エンコーディングを表します。
@see Psych::Handler#start_stream -
Psych
:: Parser :: UTF16LE -> Integer (19.0) -
UTF-16LE エンコーディングを表します。
UTF-16LE エンコーディングを表します。
@see Psych::Handler#start_stream -
Psych
:: Parser :: UTF8 -> Integer (19.0) -
UTF-8 エンコーディングを表します。
UTF-8 エンコーディングを表します。
@see Psych::Handler#start_stream