バージョン:2.5.0 > クエリ:psych > クエリ:Document

37件ヒット [1-37件を表示] （0.022秒）

トップページ >

:2.5.0

:psych

:Document

別のキーワード

種類

ライブラリ

psych (36)

クラス

モジュール

Kernel (2)
Psych (6)

キーワード

Emitter (1)
Mark (1)
NEWS for Ruby 2.5.0 (1)
Nodes (1)
Parser (1)
Stream (2)
dump (2)
end_document (1)
finish (1)
implicit (1)
implicit= (1)
implicit_end (1)
implicit_end= (1)
new (3)
parse (1)
parse_file (1)
parse_stream (2)
psych_to_yaml (1)
psych_y (1)
root (1)
start (2)
start_document (1)
tag_directives (1)
tag_directives= (1)
to_yaml (2)
version (1)
version= (1)
y (1)
yaml (1)

検索結果

Psych::Nodes::Document (87109.0)

2.5.0

クラス

YAML ドキュメントを表すクラスです。

YAML ドキュメントを表すクラスです。

このノードは Psych::Nodes::Stream の子ノードでなければ
なりません。このノードは1個の子ノードを持たなければなりません。
またこの子ノードは以下のいずれかである必要があります。
* Psych::Nodes::Sequence
* Psych::Nodes::Mapping
* Psych::Nodes::Scalar
この唯一の子ノードは「ルート」とも呼ばれ、Psych::Nodes::Document#root で
アクセスすることができます。

Psych.parse(yaml, filename = nil) -> Psych::Nodes::Document (51769.0)

2.5.0

特異メソッド

YAML ドキュメントをパースし、YAML の AST を返します。

YAML ドキュメントをパースし、YAML の AST を返します。

入力に複数のドキュメントが含まれている場合は、先頭のものを AST に変換して
返します。

filename はパース中に発生した例外のメッセージに用います。

AST については Psych::Nodes を参照してください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたと...

Psych.parse_file(filename) -> Psych::Nodes::Document (51625.0)

2.5.0

特異メソッド

filename で指定したファイルをパースして YAML の AST を返します。

filename で指定したファイルをパースして YAML の AST を返します。

@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (51412.0)

2.5.0

特異メソッド

YAML ドキュメントをパースします。 yaml が複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。

@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

Psych::Handler#start_document(version, tag_directives, implicit) -> () (51340.0)

2.5.0

インスタンスメソッド

YAML ドキュメントの始まりで呼び出されます。

YAML ドキュメントの始まりで呼び出されます。

version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。

tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。

implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。

必要に応じてこのメソッドを override してください。

@param version ...

絞り込み条件を変える

Psych::Handler#end_document(implicit) -> () (51304.0)

2.5.0

インスタンスメソッド

ドキュメントが終了したときに呼び出されます。

ドキュメントが終了したときに呼び出されます。

ドキュメントが implicit に終わったならば implicit には真が渡されます。

必要に応じてこのメソッドを override してください。

@param implicit ドキュメントが implicit に終わったかどうか

=== 例

以下の YAML ドキュメントでは implicit は true です。
---
hello world

また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
...

Psych.parse_stream(yaml) {|node| ... } -> () (51112.0)

2.5.0

特異メソッド

YAML ドキュメントをパースします。 yaml が複数の YAML ドキュメントを含む場合を取り扱うことができます。

Psych.dump(o, io, options = {}) -> () (51091.0)

2.5.0

特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

Ruby のオブジェクト o を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。

options で出力に関するオプションを以下の指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン...

Psych.dump(o, options = {}) -> String (51091.0)

2.5.0

特異メソッド

Ruby のオブジェクト o を YAML ドキュメントに変換します。

Psych::Nodes::Document.new(version=[], tag_directives=[], implicit=false) -> Psych::Nodes::Document (42745.0)

2.5.0

特異メソッド

Document オブジェクトを生成します。

Document オブジェクトを生成します。

version にはドキュメントのバージョンを指定します。
[major, minor] という配列で指定します。

tag_directives には tag directive の配列を指定します。
それぞれの tag は [prefix, suffix] という文字列の配列で
表現します。

implicit にはドキュメントが implicit に始まっているかどうかを
真偽値で指定します。

@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列...

絞り込み条件を変える

Object#psych_to_yaml(options = {}) -> String (42424.0)

2.5.0

インスタンスメソッド

オブジェクトを YAML document に変換します。

オブジェクトを YAML document に変換します。

options でオプションを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump

Kernel#psych_y(*objects) -> String (42406.0)

2.5.0

インスタンスメソッド

objects を YAML document に変換します。

objects を YAML document に変換します。

このメソッドは irb 上でのみ定義されます。

syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。

@param objects YAML document に変換する Ruby のオブジェクト

Psych::Nodes::Document#root -> Psych::Nodes::Node (42304.0)

2.5.0

インスタンスメソッド

ルートノードを返します。

Psych::Nodes::Document#implicit -> bool (42073.0)

2.5.0

インスタンスメソッド

ドキュメントが implicit に始まっているかどうかを返します。

ドキュメントが implicit に始まっているかどうかを返します。

@see Psych::Nodes::Document#implicit=,
Psych::Nodes::Document.new

Psych::Nodes::Document#implicit=(bool) (42073.0)

2.5.0

インスタンスメソッド

ドキュメントが implicit に始まっているかどうかを設定します。

ドキュメントが implicit に始まっているかどうかを設定します。

@param bool ドキュメントが implicit に始まっているかどうかの設定値
@see Psych::Nodes::Document#implicit,
Psych::Nodes::Document.new

絞り込み条件を変える

Psych::Nodes::Document#tag_directives -> [[String, String]] (42073.0)

2.5.0

インスタンスメソッド

tag directive の配列を返します。

tag directive の配列を返します。

@see Psych::Nodes::Document#tag_directives=,
Psych::Nodes::Document.new

Psych::Nodes::Document#tag_directives=(tags) (42073.0)

2.5.0

インスタンスメソッド

tag directive の配列を設定します。

tag directive の配列を設定します。

@param tags 設定する tag directive の配列
@see Psych::Nodes::Document#tag_directives,
Psych::Nodes::Document.new

Psych::Nodes::Document#version -> [Integer] (42073.0)

2.5.0

インスタンスメソッド

YAML ドキュメントのバージョンを返します。

YAML ドキュメントのバージョンを返します。

@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new

Psych::Nodes::Document#version=(ver) (42073.0)

2.5.0

インスタンスメソッド

YAML ドキュメントのバージョンを設定します。

YAML ドキュメントのバージョンを設定します。

@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new

Psych::Nodes::Document#implicit_end -> bool (42037.0)

2.5.0

インスタンスメソッド

ドキュメントが implicit に終わっているかどうかを返します。

ドキュメントが implicit に終わっているかどうかを返します。

オブジェクト生成時のデフォルト値は true です。

@see Psych::Nodes::Document#implicit_end=

絞り込み条件を変える

Psych::Nodes::Document#implicit_end=(bool) (42037.0)

2.5.0

インスタンスメソッド

ドキュメントが implicit に終わっているかどうかを設定します。

ドキュメントが implicit に終わっているかどうかを設定します。

@param bool ドキュメントが implicit に終わっているかどうかの設定値
@see Psych::Nodes::Document#implicit_end

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (34018.0)

2.5.0

特異メソッド

YAMLTree オブジェクトを生成します。

YAMLTree オブジェクトを生成します。

options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。

emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。

emitter, ss は通常デフォルトのものから変える必要はないでしょう。

@param...

Psych::Stream#start(encoding = Psych::Nodes::Stream::UTF8) -> Psych::Stream (33697.0)

2.5.0

インスタンスメソッド

Ruby オブジェクトを YAML document に変換するための準備をします。

Ruby オブジェクトを YAML document に変換するための準備をします。

変換された document は Psych::Stream.new で指定した
出力先に出力されます。

finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。

ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。

@param encoding 出...

Psych::Stream#start(encoding = Psych::Nodes::Stream::UTF8) {|em| ... } -> Psych::Stream (33697.0)

2.5.0

インスタンスメソッド

Ruby オブジェクトを YAML document に変換するための準備をします。

Psych::Nodes (33553.0)

2.5.0

モジュール

Psych が中間データとして利用している AST (Abstract Syntax Tree) に関するモジュール。

Psych が中間データとして利用している AST (Abstract Syntax Tree) に
関するモジュール。

Psych.load によって YAML ドキュメントを Ruby オブジェクトに変換
するときには、一度中間的な AST に変換され、その AST が Ruby の
オブジェクトに変換されます。

逆向き、つまり Psych.dump で Ruby のオブジェクトを
YAML ドキュメントに変換するときには、中間的な AST に変換してから
それを YAML ドキュメントに変換します。

YAML AST の各ノードのクラスはすべて Psych::Nodes の下にあり...

絞り込み条件を変える

Psych::Stream.new(io) -> Psych::Stream (33322.0)

2.5.0

特異メソッド

新たな Stream オブジェクトを生成します。

新たな Stream オブジェクトを生成します。

io で YAML document の出力先を指定します。

@param io 出力先の IO オブジェクト

Psych::Emitter (33283.0)

2.5.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::Parser (33199.0)

2.5.0

クラス

YAML のパーサ。

YAML のパーサ。

このクラスは YAML ドキュメントをパースし、コンストラクタに渡された
ハンドラにイベントを通知(呼び出し)します。
このイベントを使って YAML の AST を構築したり YAML ドキュメントを
別のフォーマット変換したりします。
Psych::Emitter を使うとパースしたドキュメントを元通りに出力
することもできます。

Psych::Parser が生成するイベントは Psych::Handler
を見てください。

以下の例では YAML ドキュメントに含まれているスカラー値を表示します。

# Handler for detecting s...

Psych::Stream (33139.0)

2.5.0

クラス

入力されたオブジェクトから変換された YAML document を指定した IO に出力する機能を持つクラスです。

入力されたオブジェクトから変換された YAML document を指定した
IO に出力する機能を持つクラスです。

start で変換を開始し、push で変換する Ruby オブジェクトを渡し、
最後に finish を呼ぶことで変換を完了します。
stream = Psych::Stream.new($stdout)
stream.start
stream.push({:foo => 'bar'})
stream.finish

YAML document は(バッファリングされずに)直接 $stdout に出力されます。

finish を確実に呼び出すためには Ps...

Object#to_yaml(options = {}) -> String (33124.0)

2.5.0

インスタンスメソッド

オブジェクトを YAML document に変換します。

絞り込み条件を変える

Kernel#y(*objects) -> String (33106.0)

2.5.0

インスタンスメソッド

objects を YAML document に変換します。

Psych::Parser::Mark (33049.0)

2.5.0

クラス

YAML document の位置を表現するクラスです。

Psych::Stream#finish -> () (33049.0)

2.5.0

インスタンスメソッド

YAML document への変換を完了し、io への出力を完了します。

Psych::Nodes::Node#to_yaml(io=nil, options={}) -> String | IO (33037.0)

2.5.0

インスタンスメソッド

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

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

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

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

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

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

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

Psych::Nodes::Node#yaml(io=nil, options={}) -> String | IO (33037.0)