1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/ext/marshal/marshal.doc
matz 3db12e8b23 Initial revision
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@2 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
1998-01-16 12:13:05 +00:00

48 lines
1.6 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.\" marshal.doc - -*- Indented-Text -*- created at: Tue May 16 12:18:08 JST 1995
** Marshal(モジュール)
rubyオブジェクトをファイルに書き出したり読みも度したりする機能を提供
するモジュール.大部分のクラスのインスタンスを書き出す事ができるが,ファ
イルへの不可能なクラスも存在し(例:IO),そのようなクラスを書き出そうと
すると例外を発生させる.
Methods:
Single Methods:
dump(obj, port[, limit])
objを再帰的にファイルに書き出すファイルに書き出せないクラスのイ
ンスタンスをファイルに書き出そうとすると例外を発生させる.ファイル
に書き出せないクラスは以下の通り.
Class, Module, Data
また,これらのクラスを間接的に指すクラス(例えばIOのサブクラス)など
も書き出せないportはIO(またはそのサブクラス)のインスタンスを指定
する.
出力するオブジェクトがメソッド`_dump_to'を定義している場合には,ファ
イル出力はそのメソッドを使って行われる.メソッド`_dump_to'は引数と
して出力先のファイルオブジェクトを受け取る.インスタンスがメソッド
`_dump_to'を持つクラスは必ず同じフォーマットを読み戻す特異メソッド
`_load_from'を定義する必要がある.
limitを指定した場合limit段以上深くリンクしたオブジェクトをダンプ
できない(デフォルトは100レベル)。負のlimitを指定すると深さチェック
を行わない。
dumps(obj)
dump()がファイルに書き出すのと同じ内容を含む文字列を返す.
load(port)
portからオブジェクトを読み込んで来て元のオブジェクトと同じ状態を
もつオブジェクトを生成するportは文字列かIO(またはそのサブクラス)
のインスタンスである.
-------------------------------------------------------
Local variables:
fill-column: 70
end: