るりまサーチ (Ruby 2.5.0)

最速Rubyリファレンスマニュアル検索!
31件ヒット [1-31件を表示] (0.033秒)
トップページ > バージョン:2.5.0[x] > クエリ:psych[x] > クエリ:Psych[x] > クエリ:yaml[x] > 種類:インスタンスメソッド[x]

別のキーワード

  1. psych new
  2. psych any
  3. psych anchor
  4. psych anchor=
  5. psych tag

ライブラリ

モジュール

キーワード

検索結果

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

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

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

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

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

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

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

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

Object#psych_to_yaml(options = {}) -> String (79180.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 (60748.0)

objects を YAML document に変換します。

objects を YAML document に変換します。

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

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

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

Object#to_yaml(options = {}) -> String (60580.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

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

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

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

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

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

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

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

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

絞り込み条件を変える

Psych::Visitors::YAMLTree#start(encoding = Nodes::Stream::UTF8) -> Psych::Nodes::Stream (51820.0)

Ruby オブジェクトから YAML AST への変換のための準備をします。

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#finish -> Psych::Nodes::Stream|nil (51646.0)

変換を終了し、構築した AST を返します。

変換を終了し、構築した AST を返します。

このメソッドは2回呼び出さないでください。

@see Psych::Visitors::YAMLTree#tree

Psych::Visitors::YAMLTree#tree -> Psych::Nodes::Stream|nil (51646.0)

変換を終了し、構築した AST を返します。

変換を終了し、構築した AST を返します。

内部で finish を呼び出し、変換処理を終了します。

このメソッドを2回以上呼ぶと、2回目以降は nil を返します。

@see Psych::Visitors::YAMLTree#finish

Psych::Visitors::YAMLTree#finished -> bool (51100.0)

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

Psych::Visitors::YAMLTree#finished? -> bool (51100.0)

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

絞り込み条件を変える

Psych::Visitors::YAMLTree#started -> bool (51100.0)

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

Psych::Visitors::YAMLTree#started? -> bool (51100.0)

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

Psych::Visitors::YAMLTree#<<(object) (51022.0)

変換対象の Ruby オブジェクトを追加します。

変換対象の Ruby オブジェクトを追加します。

@param object YAML AST へ変換する Ruby オブジェクト

Psych::Visitors::YAMLTree#push(object) (51022.0)

変換対象の Ruby オブジェクトを追加します。

変換対象の Ruby オブジェクトを追加します。

@param object YAML AST へ変換する Ruby オブジェクト

Psych::Stream#start(encoding = Psych::Nodes::Stream::UTF8) -> Psych::Stream (43312.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 (43312.0)

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

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

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

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

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

@param encoding 出...

Psych::Parser#parse(yaml) -> self (42463.0)

YAML ドキュメントをパースし、イベントハンドラに イベントを逐次通知します。

YAML ドキュメントをパースし、イベントハンドラに
イベントを逐次通知します。

@see Psych::Parser.new, Psych::Handler, Psych::Parser#handler

Psych::Handler#scalar(value, anchor, tag, plain, quoted, style) -> () (42220.0)

スカラー値を見付けたときに呼び出されます。

スカラー値を見付けたときに呼び出されます。

value にはスカラー値の文字列が渡されます。

anchor にはスカラー値に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。

tag にはスカラー値に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。

plain は plain style であるかどうか、quoted は quoted style であるかどうか
が渡されます。style には node の style が整数値で渡されます。
style は次の値のいずれか...

Psych::Handler#start_stream(encoding) -> () (42178.0)

YAML ストリームの始まりで呼び出されます。

YAML ストリームの始まりで呼び出されます。

encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE

このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。

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

@param encoding ストリームのエンコーディング(整数値)

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

objects を YAML document に変換します。

objects を YAML document に変換します。

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

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

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

絞り込み条件を変える

Psych::Handler#start_mapping(anchor, tag, implicit, style) -> () (42130.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) -> () (42130.0)

sequence の開始を見付けたときに呼び出されます。

sequence の開始を見付けたときに呼び出されます。

anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。

tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。

implicit には sequence が implicit に開始されたかどうかが
真偽値で渡されます。

style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:...

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

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

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

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

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

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

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


@param version ...

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

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

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

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

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

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

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

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

絞り込み条件を変える

Psych::ScalarScanner#tokenize(string) -> object (42088.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::Nodes::Node#tag -> String | nil (42058.0)

ノードに付加されたタグを返します。

ノードに付加されたタグを返します。

タグが付加されていない場合は nil を返します。

ast = Psych.parse(<<EOS)
---
- !!str a
- b
EOS

p ast.root.children[0].value # => "a"
p ast.root.children[0].tag # => "tag:yaml.org,2002:str"

p ast.root.children[1].value # => "b"
p ast.root.children[1].tag # => nil

Psych::Handler#end_stream -> () (42052.0)

YAML stream の終端を見付けたときに呼び出されます。

YAML stream の終端を見付けたときに呼び出されます。

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

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

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

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

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

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

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

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

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

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

=== 例

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

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

絞り込み条件を変える

Psych::Handler#alias(anchor) -> () (42022.0)

anchor という名前の alias を見付けたときに呼び出されます。

anchor という名前の alias を見付けたときに呼び出されます。

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

@param anchor aliasのアンカー文字列

=== 例

以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。

--- &ponies
- first element
- *ponies

この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。