Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > yamlライブラリ > YAMLモジュール

module YAML

クラスの継承リスト: YAML

要約

YAML (YAML Ain't Markup Language) を扱うモジュールです。

参考

* YAML Specification

* YAML4R

* Ruby with YAMLhttp://www.namikilab.tuat.ac.jp/~sasada/prog/yaml.html * Rubyist Magazinehttp://jp.rubyist.net/magazine/

特異メソッド

定義 説明
add_builtin_type(type_re) {|type, val| ...}

yaml.org,2002ドメインに属しているクラスをYAMLに追加し そのクラスを見つけたときの操作を指定します。

add_domain_type(domain, type_re) {|type, val| ...}

YAMLドメインに属しているクラスをYAMLに追加し、 そのクラスを見つけたときの操作を指定します。

add_private_type(type_re) {|type, val| ...}

プライベートタイプのクラスをYAMLに追加し、 そのクラスを見つけたときの操作を指定します。

add_ruby_type(type_re) {|type, val| ...}

rubyタイプのクラスをYAMLに追加し、 そのクラスを見つけたときの操作を指定します。

detect_implicit(val)

文字列のタイプを検知する

dump(obj, io = nil)

与えられた obj を YAML フォーマットに変換し、io に書き込みます。 io が与えられていない場合は、YAML フォーマットの文字列を返します。

dump_stream(*objs)

与えられた objs を順に YAML フォーマットに変換していき、一つの文字列にまとめたものを返します。

each_document(io) {|obj| ...}
load_documents(io) {|obj| ...}

与えられた io から YAML フォーマットの文書をすべて順に読み込み Ruby のオブジェクトに変換し、 生成したオブジェクトを引数としてブロックを評価していきます。

each_node(io) {|obj| ...}

与えられた io から YAML フォーマットの文書をすべて順に読み込み YAML::Syck::Mapオブジェクトに変換し、 生成したオブジェクトを引数としてブロックを評価していきます。

load(io)
load(str)

YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。 引数として IO オブジェクトと文字列を受け付けます。 io や 文字列が複数の YAML ドキュメントを含んでいても、最初のものしか Ruby のオブジェクトに変換しません。

load_file(file)

与えられた名前のファイルから YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。 ファイルが複数の YAML ドキュメントを含んでいても、 最初のものしか Ruby のオブジェクトに変換しません。

load_stream(io)

与えられた io から YAML フォーマットの文書を すべて順に読み込んで Ruby のオブジェクトに変換していき、 それらオブジェクトを含んだ YAML::Stream を返します。

object_maker(obj_class, val)

与えられたobj_class クラスに、valハッシュをインスタンス変数として追加し obj_classクラスのインスタンスを生成して返します。

parse(io)

与えられた io から YAML フォーマットの文書をパースし YAML::Syck::Nodeオブジェクトに変換します。 複数のドキュメントを読み込む場合は、YAML.parse_documents を使用します。

parse_documents(io) {|obj| ...}

与えられた io から YAML フォーマットの文書をパースし YAML::Syck::Nodeオブジェクトに変換し、 生成したオブジェクトを引数としてブロックを評価していきます。

parse_file(file_path)

file_pathのファイルから一つのYAMLドキュメントをパースし、 YAML::Syck::Nodeオブジェクトを返します。

quick_emit(oid, opts={}) {|obj| ...}
read_type_class(type, obj_class)
tagurize(val)
transfer
try_implicit(obj)

定数

定義 説明
DEFAULTS

YAMLのデフォルトの設定のハッシュです。 Ruby 1.8.3 以降では変更できません。