るりまサーチ (Ruby 2.7.0)

最速Rubyリファレンスマニュアル検索!
19件ヒット [1-19件を表示] (0.010秒)
トップページ > ライブラリ:psych[x] > モジュール:Psych[x] > バージョン:2.7.0[x]

種類

キーワード

検索結果

Psych.dump(o, io, options = {}) -> () (10.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 (10.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 (10.0)

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

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

@param objects 変換対象のオブジェクト列

//emlist[例][ruby]{
Psych
.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//}...

Psych.libyaml_version -> [Integer, Integer, Integer] (10.0)

libyaml のバージョンを返します。

...libyaml のバージョンを返します。

[major, minor patch-level] という 3 つの整数からなる配列を返します。

@see Psych::LIBYAML_VERSION...

Psych.load(yaml, filename = nil, fallback: false, symbolize_names: false) -> object (10.0)

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

...に発生した例外のメッセージに用います。


@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り...
...raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します
@see Psych.parse

//emlist[例][ruby]{
Psych
.load("--- a") # => 'a'
Psych
.load("---\n - a\n - b") # => ['a', 'b']

begin
Psych
.load("--- `", filename: "file.txt")
rescue Psych::Syn...
...ード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返します。

//emlist[例][ruby]{
Psych
.load("---\n foo: bar") # => {"foo"=>"bar"}
Psych
.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
//}...

絞り込み条件を変える

Psych.load(yaml, filename: nil, fallback: false, symbolize_names: false) -> object (10.0)

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

...に発生した例外のメッセージに用います。


@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り...
...raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します
@see Psych.parse

//emlist[例][ruby]{
Psych
.load("--- a") # => 'a'
Psych
.load("---\n - a\n - b") # => ['a', 'b']

begin
Psych
.load("--- `", filename: "file.txt")
rescue Psych::Syn...
...ード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返します。

//emlist[例][ruby]{
Psych
.load("---\n foo: bar") # => {"foo"=>"bar"}
Psych
.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
//}...

Psych.load_file(filename) -> object (10.0)

filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。

...filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。

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

Psych.load_stream(yaml, filename=nil) -> [object] (10.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| ... } -> () (10.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 (10.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.parse_file(filename) -> Psych::Nodes::Document (10.0)

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

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

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

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (10.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| ... } -> () (10.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.parser -> Psych::Parser (10.0)

デフォルトで使われるのパーサを返します。

デフォルトで使われるのパーサを返します。

Psych.safe_load(yaml, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (10.0)

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

...えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych
.safe_load(yaml, permitted_classes: [Date])
//}

すると上のクラス一覧に加えて Date クラスが読み込まれます。

エイリア...
...の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych
.safe_load yaml # => 例外発生
Psych
.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}

yaml に許可されていないクラスが含まれていた場合は、
Psych
::DisallowedClass 例外が発生...
...します。

yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych
::BadAlias 例外が発生します。

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

キーワード引数 symbolize_names に true を指定した場...

絞り込み条件を変える

Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false) -> object (10.0)

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

...えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitted_classes: に Date を渡した例][ruby]{
Psych
.safe_load(yaml, permitted_classes: [Date])
//}

すると上のクラス一覧に加えて Date クラスが読み込まれます。

エイリア...
...の例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych
.safe_load yaml # => 例外発生
Psych
.safe_load yaml, aliases: true # => エイリアスが読み込まれる
//}

yaml に許可されていないクラスが含まれていた場合は、
Psych
::DisallowedClass 例外が発生...
...します。

yaml がエイリアスを含んでいてキーワード引数 aliases が false の時、
Psych
::BadAlias 例外が発生します。

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

キーワード引数 symbolize_names に true を指定した場...

Psych.to_json(o) -> String (10.0)

Ruby のオブジェクト o を JSON の文字列に変換します。

Ruby のオブジェクト o を JSON の文字列に変換します。

@param o 変換対象となるオブジェクト

Psych::LIBYAML_VERSION -> String (10.0)

libyaml のバージョン。

libyaml のバージョン。

Psych::VERSION -> String (10.0)

Psych のバージョン。

...Psych のバージョン。...