検索結果

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

• 3.2

• 特異メソッド

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

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

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

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

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

• Psych

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

• 3.2

• 特異メソッド

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

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

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

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

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

• Psych

Marshal.#dump(obj, limit = -1) -> String (54433.0)

• 3.2

• モジュール関数

obj を指定された出力先に再帰的に出力します。

obj を指定された出力先に再帰的に出力します。

ファイルに書き出せないオブジェクトをファイルに書き出そうとすると
例外 TypeError が発生します。
ファイルに書き出せないオブジェクトは以下の通りです。

* 名前のついてない Class/Module オブジェクト。(この場
合は、例外 ArgumentError が発生します。無名クラスについて
は、Module.new を参照。)
* システムがオブジェクトの状態を保持するもの。具体的には以下のイン
スタンス。Dir, File::Stat, IO とそのサブクラス
File, Socket など。...

• ArgumentError
• Class
• Continuation
• Data
• Dir
• File
• File::Stat
• Hash
• IO
• Marshal
• MatchData
• Method
• Module
• Proc
• Socket
• String
• Thread
• ThreadGroup
• TypeError
• UnboundMethod

Marshal.#dump(obj, port, limit = -1) -> IO (54433.0)

• 3.2

• モジュール関数

obj を指定された出力先に再帰的に出力します。

obj を指定された出力先に再帰的に出力します。

ファイルに書き出せないオブジェクトをファイルに書き出そうとすると
例外 TypeError が発生します。
ファイルに書き出せないオブジェクトは以下の通りです。

* 名前のついてない Class/Module オブジェクト。(この場
合は、例外 ArgumentError が発生します。無名クラスについて
は、Module.new を参照。)
* システムがオブジェクトの状態を保持するもの。具体的には以下のイン
スタンス。Dir, File::Stat, IO とそのサブクラス
File, Socket など。...

• ArgumentError
• Class
• Continuation
• Data
• Dir
• File
• File::Stat
• Hash
• IO
• Marshal
• MatchData
• Method
• Module
• Proc
• Socket
• String
• Thread
• ThreadGroup
• TypeError
• UnboundMethod

JSON.#dump(object, io = nil, limit = nil) -> String | IO (54430.0)

• 3.2

• モジュール関数

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを引数として JSON.#generate を呼び出します。


@param object ダンプするオブジェクトを指定します。

@param io IO のように write メソッドを実装しているオブジェクトを指定します。

@param limit 指定した場合、limit 段以上深くリンクしたオブジェクトをダンプできません。

@raise ArgumentError オブジェクトのネストの深さが limit を越えた場合に発生します。

//emlist[例][ruby]{
re...

• IO
• JSON
• Marshal

絞り込み条件を変える

Object#_dump(limit) -> String (18706.0)

• 3.2

• インスタンスメソッド

Marshal.#dump において出力するオブジェクトがメソッド _dump を定義している場合には、そのメソッドの結果が書き出されます。

Marshal.#dump において出力するオブジェクトがメソッド _dump
を定義している場合には、そのメソッドの結果が書き出されます。

バージョン1.8.0以降ではObject#marshal_dump, Object#marshal_loadの使用
が推奨されます。 Marshal.dump するオブジェクトが _dump と marshal_dump の両方の
メソッドを持つ場合は marshal_dump が優先されます。

メソッド _dump は引数として再帰を制限するレベル limit を受
け取り、オブジェクトを文字列化したものを返します。

インスタンスがメソッド _...

• Object
• Time

Psych.dump_stream(*objects) -> String (18340.0)

• 3.2

• 特異メソッド

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

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

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

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

• Psych

Encoding::Converter#convert(source_string) -> String (181.0)

• 3.2

• インスタンスメソッド

与えられた文字列を変換して、変換できた結果を返します。 引数の末尾の文字がバイト列の途中で終わっている場合、そのバイト列は変換器内に取り置かれます。 変換を終了させるには Encoding::Converter#finish を呼びます。

与えられた文字列を変換して、変換できた結果を返します。
引数の末尾の文字がバイト列の途中で終わっている場合、そのバイト列は変換器内に取り置かれます。
変換を終了させるには Encoding::Converter#finish を呼びます。

Encoding::Converter を用いると、文字列の一部または全部を渡して変換を行うことができます。よって、不正なバイトを意識せずにストリームから読み出した文字列を変換したいときには Encoding::Converter が適します。

なお、Encoding::Converter#convert では、これらの例外を捕獲しても、例外を起こしたと...

• Encoding::Converter

Kernel.#spawn(env, program, *args, options={}) -> Integer (172.0)

• 3.2

• モジュール関数

引数を外部コマンドとして実行しますが、生成した 子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数を外部コマンドとして実行しますが、生成した
子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

env に Hash を渡すことで、exec(2) で子プロセス内で
ファイルを実行する前に環境変数を変更することができます。
Hash のキーは環境変数名文字列、Hash の値に設定する値とします。
nil とすることで環境変数が削除(unsetenv(3))されます。
//emlist[例][ruby]{
# FOO を BAR にして BAZ を削除する
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)
//...

• IO
• Kernel

Kernel.#spawn(program, *args) -> Integer (172.0)

• 3.2

• モジュール関数

引数を外部コマンドとして実行しますが、生成した 子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数を外部コマンドとして実行しますが、生成した
子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

env に Hash を渡すことで、exec(2) で子プロセス内で
ファイルを実行する前に環境変数を変更することができます。
Hash のキーは環境変数名文字列、Hash の値に設定する値とします。
nil とすることで環境変数が削除(unsetenv(3))されます。
//emlist[例][ruby]{
# FOO を BAR にして BAZ を削除する
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)
//...

• IO
• Kernel

絞り込み条件を変える

Encoding::Converter#insert_output(string) -> nil (163.0)

• 3.2

• インスタンスメソッド

変換器内のバッファに文字列を挿入します。 バッファに保持された文字列は、次の変換時の変換結果と一緒に返されます。

変換器内のバッファに文字列を挿入します。
バッファに保持された文字列は、次の変換時の変換結果と一緒に返されます。

変換先がステートフルなエンコーディングであった場合、
挿入された文字列は状態に基づいて変換され、状態を更新します。

このメソッドは変換に際してエラーが発生した際にのみ利用されるべきです。

@param string 挿入する文字列

//emlist[][ruby]{
ec = Encoding::Converter.new("utf-8", "iso-8859-1")
src = "HIRAGANA LETTER A is \u{3042}."
dst = ""
p ec....

• Encoding::Converter

Object#marshal_load(obj) -> object (163.0)

• 3.2

• インスタンスメソッド

Marshal.#load を制御するメソッドです。

Marshal.#load を制御するメソッドです。

some のダンプ結果（Marshal.dump(some)） をロードする（Marshal.load(Marshal.dump(some))）に
は some がメソッド marshal_load を持っていなければなりません。
このとき、marshal_dump の返り値が marshal_load の引数に利用されます。
marshal_load 時の self は、生成されたばかり（Class#allocate されたばかり） の状態です。

marshal_dump/marshal_load の仕組みは Ruby 1.8.0 ...

• Marshal
• Object

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

• 3.2

• 特異メソッド

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

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

デフォルトでは以下のクラスのオブジェクトしか変換しません。

* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

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

• 3.2

• 特異メソッド

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

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

デフォルトでは以下のクラスのオブジェクトしか変換しません。

* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

Encoding::Converter#primitive_convert(source_buffer, destination_buffer) -> Symbol (127.0)

• 3.2

• インスタンスメソッド

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、Encoding::Converter#primitive_convert が唯一の方法になります。

@param source_buffer 変換元文字列のバッファ
@param destination_buffer 変換先文字列を格納するバッファ
@param destination_byteoffset 変換先バッファでのオフセット
@param destination_bytesize 変換先バッファの容量
@...

• Encoding::Converter

絞り込み条件を変える

Encoding::Converter#primitive_convert(source_buffer, destination_buffer, destination_byteoffset) -> Symbol (127.0)

• 3.2

• インスタンスメソッド

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、Encoding::Converter#primitive_convert が唯一の方法になります。

@param source_buffer 変換元文字列のバッファ
@param destination_buffer 変換先文字列を格納するバッファ
@param destination_byteoffset 変換先バッファでのオフセット
@param destination_bytesize 変換先バッファの容量
@...

• Encoding::Converter

Encoding::Converter#primitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize) -> Symbol (127.0)

• 3.2

• インスタンスメソッド

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、Encoding::Converter#primitive_convert が唯一の方法になります。

@param source_buffer 変換元文字列のバッファ
@param destination_buffer 変換先文字列を格納するバッファ
@param destination_byteoffset 変換先バッファでのオフセット
@param destination_bytesize 変換先バッファの容量
@...

• Encoding::Converter

Encoding::Converter#primitive_convert(source_buffer, destination_buffer, destination_byteoffset, destination_bytesize, options) -> Symbol (127.0)

• 3.2

• インスタンスメソッド

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

エンコーディング変換のためのメソッドの中で、もっとも細かな扱いが可能なメソッドです。

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、Encoding::Converter#primitive_convert が唯一の方法になります。

@param source_buffer 変換元文字列のバッファ
@param destination_buffer 変換先文字列を格納するバッファ
@param destination_byteoffset 変換先バッファでのオフセット
@param destination_bytesize 変換先バッファの容量
@...

• Encoding::Converter

Random#marshal_load(array) -> Random (121.0)

• 3.2

• インスタンスメソッド

Random#marshal_dump で得られた配列を基に、Randomオブジェクトを復元します。

Random#marshal_dump で得られた配列を基に、Randomオブジェクトを復元します。

@param array 三要素以下からなる配列を指定します。
何を指定するかはRandom#marshal_dumpを参考にしてください。

@raise ArgumentError array が3より大きい場合に発生します。

//emlist[例][ruby]{
r1 = Random.new(1)
a1 = r1.marshal_dump
r2 = Random.new(3)
r3 = r2.marshal_load(a1)

p r1 == r2 # ...

• Random

Kernel.#spawn(command, options={}) -> Integer (82.0)

• 3.2

• モジュール関数

引数を外部コマンドとして実行しますが、生成した 子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数を外部コマンドとして実行しますが、生成した
子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。


=== 引数の解釈

この形式では command が shell のメタ文字
//emlist{
* ? {} [] <> () ~ & | \ $ ; ' ` " \n
//}
を含む場合、shell 経由で実行されます。
そうでなければインタプリタから直接実行されます。


@param command コマンドを文字列で指定します。
@param env 更新する環境変数を表す Hash
@param options オプションパラメータ Hash...

• Kernel

絞り込み条件を変える

Kernel.#spawn(env, command, options={}) -> Integer (82.0)

• 3.2

• モジュール関数

引数を外部コマンドとして実行しますが、生成した 子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数を外部コマンドとして実行しますが、生成した
子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。


=== 引数の解釈

この形式では command が shell のメタ文字
//emlist{
* ? {} [] <> () ~ & | \ $ ; ' ` " \n
//}
を含む場合、shell 経由で実行されます。
そうでなければインタプリタから直接実行されます。


@param command コマンドを文字列で指定します。
@param env 更新する環境変数を表す Hash
@param options オプションパラメータ Hash...

• Kernel

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

• 3.2

• 特異メソッド

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

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

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

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

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

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

@param...

• Psych::ScalarScanner
• Psych::TreeBuilder
• Psych::Visitors::YAMLTree
• String

YAML::Store.new(file_name, thread_safe = false, yaml_opts = {}) -> YAML::Store (73.0)

• 3.2

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。

@param thread_safe 自身をスレッドセーフにして初期化するかどうか。

@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。

• Hash
• YAML::Store

YAML::Store.new(file_name, yaml_opts = {}) -> YAML::Store (73.0)

• 3.2

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。

@param thread_safe 自身をスレッドセーフにして初期化するかどうか。

@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。

• Hash
• YAML::Store

Class#_load(str) -> Class (67.0)

• 3.2

• インスタンスメソッド

Object#_dump を参照して下さい。

Object#_dump を参照して下さい。

@param str Ruby のオブジェクトがダンプされた文字列を指定します。

• Class

絞り込み条件を変える

BigDecimal._load(str) -> BigDecimal (55.0)

• 3.2

• 特異メソッド

引数で指定された文字列を元に BigDecimal オブジェクトを復元します。 Marshal.#load から呼び出されます。

引数で指定された文字列を元に BigDecimal オブジェクトを復元します。
Marshal.#load から呼び出されます。

@param str 復元する値を表す文字列を指定します。

@raise TypeError 引数に不正な文字が含まれる場合に発生します。

@see BigDecimal#_dump, Marshal.#dump, Marshal.#load

• BigDecimal

Marshal.#load(port, proc = nil) -> object (55.0)

• 3.2

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Marshal.#restore(port, proc = nil) -> object (55.0)

• 3.2

• モジュール関数

port からマーシャルデータを読み込んで、元のオブジェクトと同 じ状態をもつオブジェクトを生成します。

port からマーシャルデータを読み込んで、元のオブジェクトと同
じ状態をもつオブジェクトを生成します。

proc として手続きオブジェクトが与えられた場合には読み込んだ
オブジェクトを引数にその手続きを呼び出します。

//emlist[例][ruby]{
str = Marshal.dump(["a", 1, 10 ** 10, 1.0, :foo])
p Marshal.load(str, proc {|obj| p obj})

# => "a"
# 1
# 10000000000
# 1.0
# :foo
# ["a", 1, 10000000000...

• IO
• Marshal
• Proc
• String

Object#clone(freeze: nil) -> object (55.0)

• 3.2

• インスタンスメソッド

オブジェクトの複製を作成して返します。

オブジェクトの複製を作成して返します。

dup はオブジェクトの内容をコピーし、
clone はそれに加えて freeze, 特異メソッドなどの情報も含めた完全な複製を作成します。

clone や dup は浅い(shallow)コピーであることに注意してください。後述。

TrueClass, FalseClass, NilClass, Symbol, そして Numeric クラスのインスタンスなど一部のオブジェクトは複製ではなくインスタンス自身を返します。

@param freeze true を指定すると freeze されたコピーを返します。
fa...

• FalseClass
• Marshal
• NilClass
• Numeric
• Object
• Symbol
• TrueClass

Object#dup -> object (55.0)

• 3.2

• インスタンスメソッド

オブジェクトの複製を作成して返します。

オブジェクトの複製を作成して返します。

dup はオブジェクトの内容をコピーし、
clone はそれに加えて freeze, 特異メソッドなどの情報も含めた完全な複製を作成します。

clone や dup は浅い(shallow)コピーであることに注意してください。後述。

TrueClass, FalseClass, NilClass, Symbol, そして Numeric クラスのインスタンスなど一部のオブジェクトは複製ではなくインスタンス自身を返します。

@param freeze true を指定すると freeze されたコピーを返します。
fa...

• FalseClass
• Marshal
• NilClass
• Numeric
• Object
• Symbol
• TrueClass

絞り込み条件を変える

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

• 3.2

• インスタンスメソッド

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

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

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

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

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

• Object
• syck

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

• 3.2

• インスタンスメソッド

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

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

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

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

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

• Object
• syck

Object.yaml_tag(tag) -> () (55.0)

• 3.2

• 特異メソッド

クラスと tag の間を関連付けます。

クラスと tag の間を関連付けます。

これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。

@param tag 対象のクラスに関連付けるタグの文字列

=== Example
require 'psych'

class Foo
def initialize(x)
@x = x
end

attr_reader :x
end

# Dumps Ruby object normally
p Psych.dump(Foo.new(3))
...

• Object

Delegator#marshal_load(obj) -> object (37.0)

• 3.2

• インスタンスメソッド

シリアライズされたオブジェクトから、Delegator#__getobj__ が返すオブジェクトを再現します。

シリアライズされたオブジェクトから、Delegator#__getobj__ が返すオブジェクトを再現します。

@param obj Delegator#marshal_dumpの戻り値のコピー

• Delegator

IRB::Context#inspect_mode=(opt) (37.0)

• 3.2

• インスタンスメソッド

実行結果の出力方式を opt に設定します。

実行結果の出力方式を opt に設定します。

@param opt 以下のいずれかを指定します。
: false, :to_s, :raw
出力結果を to_s したものを表示します。
: true, :p, :inspect
出力結果を inspect したものを表示します。
: :pp, :pretty_inspect
出力結果を pretty_inspect したものを表示します。
: :yaml, :YAML
出力結果を YAML 形式にしたものを表示します。
: :marshal, :Marshal, :MARSHAL, Marshal
出力結果を Marsh...

• IRB::Context
• Marshal

絞り込み条件を変える