種類
- インスタンスメソッド (46)
- 特異メソッド (26)
- ライブラリ (2)
- 文書 (1)
ライブラリ
-
irb
/ context (1) - psych (48)
-
rubygems
/ commands / build _ command (1) -
rubygems
/ config _ file (1) -
rubygems
/ package / tar _ input (1) -
rubygems
/ server (1) -
rubygems
/ specification (3) -
yaml
/ dbm (14) -
yaml
/ store (2)
クラス
-
Gem
:: Commands :: BuildCommand (1) -
Gem
:: ConfigFile (1) -
Gem
:: Package :: TarInput (1) -
Gem
:: Server (1) -
Gem
:: Specification (3) -
IRB
:: Context (1) - Module (2)
- Object (3)
-
Psych
:: Handler (7) -
Psych
:: Nodes :: Document (3) -
Psych
:: Nodes :: Mapping (1) -
Psych
:: Nodes :: Node (2) -
Psych
:: Nodes :: Sequence (1) -
Psych
:: Parser (2) -
Psych
:: ScalarScanner (1) -
Psych
:: Stream (3) -
Psych
:: Visitors :: YAMLTree (6) -
YAML
:: DBM (14) -
YAML
:: Store (2)
キーワード
-
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (1) - << (1)
- [] (1)
- []= (1)
- alias (1)
- delete (1)
-
delete
_ if (1) - dump (2)
-
dump
_ stream (1) -
end
_ document (1) - fetch (1)
- finish (1)
-
from
_ yaml (1) -
has
_ value? (1) - index (1)
-
inspect
_ mode= (1) - key (1)
-
libyaml
_ version (1) - load (1)
-
load
_ documents (2) -
load
_ file (2) -
load
_ gemspec (1) -
load
_ stream (2) - new (8)
-
normalize
_ yaml _ input (1) - parse (2)
-
parse
_ file (1) -
parse
_ stream (2) -
psych
_ to _ yaml (1) -
psych
_ y (1) -
psych
_ yaml _ as (1) - push (1)
- replace (1)
- rubygems (1)
-
safe
_ load (1) - scalar (1)
- select (2)
- start (3)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - store (1)
-
to
_ yaml (2) - tokenize (1)
- tree (1)
- update (1)
-
values
_ at (1) - version (1)
- version= (1)
- y (1)
- yaml? (1)
-
yaml
_ as (1) -
yaml
_ initialize (1) -
yaml
_ tag (1)
検索結果
先頭5件
-
yaml (115159.0)
-
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
//emlist[例1: 構造化された配列][ruby]{
require 'yaml'
data = ["Taro san", "Jiro san", "Saburo san"]
str_r = YAML.dump(data)
str_l = <<~YAML_EOT
---
- Taro san
- Jiro san
- Saburo san
YAML_EOT
p str_r == str_l # => true
//}
... -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (54409.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
Gem
:: Server # yaml(request , response) -> () (54340.0) -
メソッド名に対応する URI に対するリクエストを処理するメソッドです。
メソッド名に対応する URI に対するリクエストを処理するメソッドです。
@param request WEBrick::HTTPRequest オブジェクトが自動的に指定されます。
@param response WEBrick::HTTPResponse オブジェクトが自動的に指定されます。 -
Object
# psych _ to _ yaml(options = {}) -> String (18463.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 -
Object
# to _ yaml(options = {}) -> String (18463.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 -
Object
. yaml _ tag(tag) -> () (18412.0) -
クラスと 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))
... -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (18409.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
Gem
:: Specification . from _ yaml(input) -> Gem :: Specification (18388.0) -
YAML ファイルから gemspec をロードします。
YAML ファイルから gemspec をロードします。
YAML ファイルから Gem::Specification をロードすると、通常の Ruby オブジェクトの
初期化ルーチン (#initialize) を通りません。このメソッドは初期化ルーチンの一部を実行し、
gemspec のバージョンチェックも行います。
@param input 文字列か IO オブジェクトを指定します。 -
Gem
:: Commands :: BuildCommand # yaml?(filename) -> bool (18370.0) -
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
@param filename ファイル名を指定します。 -
Gem
:: Specification . normalize _ yaml _ input(input) -> String (18370.0) -
YAML 形式の gemspec を正しくフォーマットします。
YAML 形式の gemspec を正しくフォーマットします。
@param input 文字列か IO オブジェクトを指定します。 -
Module
# psych _ yaml _ as(tag) -> () (18361.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Module
# yaml _ as(tag) -> () (18361.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Gem
:: Specification # yaml _ initialize (18352.0) -
@todo
@todo -
Psych
. libyaml _ version -> [Integer , Integer , Integer] (18319.0) -
libyaml のバージョンを返します。
libyaml のバージョンを返します。
[major, minor patch-level] という 3 つの整数からなる配列を返します。
@see Psych::LIBYAML_VERSION -
YAML
:: Store . new(file _ name , thread _ safe = false , yaml _ opts = {}) -> YAML :: Store (9703.0) -
自身を初期化します。
自身を初期化します。
@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。
@param thread_safe 自身をスレッドセーフにして初期化するかどうか。
@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。 -
YAML
:: Store . new(file _ name , yaml _ opts = {}) -> YAML :: Store (9703.0) -
自身を初期化します。
自身を初期化します。
@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。
@param thread_safe 自身をスレッドセーフにして初期化するかどうか。
@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。 -
Psych
:: Visitors :: YAMLTree . new(options = {} , emitter = Psych :: TreeBuilder . new , ss = Psych :: ScalarScanner . new) -> Psych :: Visitors :: YAMLTree (9391.0) -
YAMLTree オブジェクトを生成します。
YAMLTree オブジェクトを生成します。
options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。
emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。
ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。
emitter, ss は通常デフォルトのものから変える必要はないでしょう。
@param... -
YAML
:: DBM # replace(other) -> YAML :: DBM (9340.0) -
self の内容を other の内容で置き換えます。
self の内容を other の内容で置き換えます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。
自身を返します。 -
YAML
:: DBM # delete _ if {|key , val| . . . } -> YAML :: DBM (9322.0) -
ブロックを評価した値が真であれば該当する要素を削除します。
ブロックを評価した値が真であれば該当する要素を削除します。
自身を返します。このメソッドは self を破壊的に変更します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
Psych
:: Visitors :: YAMLTree # start(encoding = Nodes :: Stream :: UTF8) -> Psych :: Nodes :: Stream (9085.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 に設定するエンコーディング -
YAML
:: DBM # []=(key , value) -> object (9073.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
YAML
:: DBM # index(value) -> String | nil (9073.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。
[注意] 非推奨のメソッドです。代わりに #key を使用してください。
@see YAML::DBM#key -
YAML
:: DBM # store(key , value) -> object (9073.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
YAML
:: DBM # [](key) -> object | nil (9055.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は nil を返します。DBM#[] とは異
なり、IndexError は発生しません。
@param key キーを文字列で指定します。
@see YAML::DBM#fetch -
YAML
:: DBM # fetch(key , ifnone = nil) -> object (9055.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は ifnone で指定した値を返します。
@param key キーを文字列で指定します。
@see YAML::DBM#[] -
YAML
:: DBM # select { . . . } -> [[String , object]] (9055.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
YAML
:: DBM # select(*keys) -> [object] (9055.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
Psych
:: Visitors :: YAMLTree # <<(object) (9037.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
Psych
:: Visitors :: YAMLTree # push(object) (9037.0) -
変換対象の Ruby オブジェクトを追加します。
変換対象の Ruby オブジェクトを追加します。
@param object YAML AST へ変換する Ruby オブジェクト -
YAML
:: DBM # delete(key) -> object | nil (9037.0) -
key をキーとする要素を削除します。
key をキーとする要素を削除します。
削除した要素を返します。key に対応する値が見つからなかった場合は nil を
返します。
@param key キーを文字列で指定します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
YAML
:: DBM # has _ value?(value) -> bool (9037.0) -
value を値とする組がデータベース中に存在する時、真を返します。
value を値とする組がデータベース中に存在する時、真を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # key(value) -> String | nil (9037.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # update(other) -> self (9037.0) -
自身と other の内容をマージ(統合)します。
自身と other の内容をマージ(統合)します。
重複するキーに対応する値は other の内容で上書きされます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。 -
Psych
:: Visitors :: YAMLTree # finish -> Psych :: Nodes :: Stream|nil (9019.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
このメソッドは2回呼び出さないでください。
@see Psych::Visitors::YAMLTree#tree -
Psych
:: Visitors :: YAMLTree # tree -> Psych :: Nodes :: Stream|nil (9019.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
内部で finish を呼び出し、変換処理を終了します。
このメソッドを2回以上呼ぶと、2回目以降は nil を返します。
@see Psych::Visitors::YAMLTree#finish -
YAML
:: DBM # values _ at(*keys) -> [object] (9019.0) -
keys に対応する値を配列に格納して返します。
keys に対応する値を配列に格納して返します。
対応するキーが見つからなかった要素には nil が格納されます。
@param keys キーを文字列で指定します。複数指定することができます。 -
Psych
. safe _ load(yaml , whitelist _ classes = [] , whitelist _ symbols = [] , aliases = false , filename = nil) -> object (568.0) -
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。
デフォルトでは以下のクラスのオブジェクトしか変換しません。
* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash
再帰的なデータ構造はデフォルトでは許可されていません。
任意のクラスを許可するには whitelist_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:
//emlist[][ruby]{
Psych.s... -
Psych
. load(yaml , filename = nil , fallback = false) -> object (532.0) -
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。
入力に複数のドキュメントが含まれている場合は、先頭のものを変換して
返します。
filename はパース中に発生した例外のメッセージに用います。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@raise Psych::Syn... -
Psych
. parse(yaml , filename = nil) -> Psych :: Nodes :: Document (526.0) -
YAML ドキュメントをパースし、YAML の AST を返します。
YAML ドキュメントをパースし、YAML の AST を返します。
入力に複数のドキュメントが含まれている場合は、先頭のものを AST に変換して
返します。
filename はパース中に発生した例外のメッセージに用います。
AST については Psych::Nodes を参照してください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたと... -
Psych
. parse _ stream(yaml) -> Psych :: Nodes :: Stream (523.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes
//emlist[例][ruby]{
Psych.parse_stream("--... -
Psych
. parse _ stream(yaml) {|node| . . . } -> () (523.0) -
YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。
ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。
ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。
@see Psych::Nodes
//emlist[例][ruby]{
Psych.parse_stream("--... -
Psych
. load _ stream(yaml , filename=nil) -> [object] (463.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
複数の 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...") do |ruby|
list << ru... -
Psych
. load _ stream(yaml , filename=nil) {|obj| . . . } -> () (463.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。
複数の 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...") do |ruby|
list << ru... -
Psych
. load _ documents(yaml) -> [object] (445.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。
複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
Psych
. load _ documents(yaml) {|obj| . . . } -> () (445.0) -
複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。
複数の YAML ドキュメントを含むデータを
Ruby のオブジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。
@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
Psych
:: Parser # parse(yaml) -> self (370.0) -
YAML ドキュメントをパースし、イベントハンドラに イベントを逐次通知します。
YAML ドキュメントをパースし、イベントハンドラに
イベントを逐次通知します。
@see Psych::Parser.new, Psych::Handler, Psych::Parser#handler -
Psych
:: Handler # start _ document(version , tag _ directives , implicit) -> () (175.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (145.0) -
1.6.8から1.8.0への変更点(まとめ) * ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/文法の変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/正規表現>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Marshal>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Windows 対応>)) * ((<1.6.8から1.8.0への変更点(まとめ)/廃止された(される予定の)機能>)) * ((<1.6.8から1.8.0への変更点(まとめ)/ライブラリ>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張ライブラリAPI>)) * ((<1.6.8から1.8.0への変更点(まとめ)/バグ修正>)) * ((<1.6.8から1.8.0への変更点(まとめ)/サポートプラットフォームの追加>))
1.6.8から1.8.0への変更点(まとめ)
* ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>))
* ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>))
* ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>))... -
Psych
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (145.0) -
スカラー値を見付けたときに呼び出されます。
スカラー値を見付けたときに呼び出されます。
value にはスカラー値の文字列が渡されます。
anchor にはスカラー値に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag にはスカラー値に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
plain は plain style であるかどうか、quoted は quoted style であるかどうか
が渡されます。style には node の style が整数値で渡されます。
style は次の値のいずれか... -
Psych
. dump(o , io , options = {}) -> () (139.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
Ruby のオブジェクト o を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。
options で出力に関するオプションを以下の指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン... -
Psych
. dump(o , options = {}) -> String (139.0) -
Ruby のオブジェクト o を YAML ドキュメントに変換します。
Ruby のオブジェクト o を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、変換されたドキュメントが
その IO に書き込まれます。
指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値と
なります。
options で出力に関するオプションを以下の指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン... -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (127.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) -> () (127.0) -
sequence の開始を見付けたときに呼び出されます。
sequence の開始を見付けたときに呼び出されます。
anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には sequence が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:... -
Psych
:: Nodes :: Document . new(version=[] , tag _ directives=[] , implicit=false) -> Psych :: Nodes :: Document (109.0) -
Document オブジェクトを生成します。
Document オブジェクトを生成します。
version にはドキュメントのバージョンを指定します。
[major, minor] という配列で指定します。
tag_directives には tag directive の配列を指定します。
それぞれの tag は [prefix, suffix] という文字列の配列で
表現します。
implicit にはドキュメントが implicit に始まっているかどうかを
真偽値で指定します。
@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列... -
Psych
:: Nodes :: Mapping . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Mapping (109.0) -
新たな mapping オブジェクトを生成します。
新たな mapping オブジェクトを生成します。
anchor には mapping に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。
tag には mapping に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。
implicit には mapping が implicit に開始されたかどうかを
真偽値で指定します。
style には YAML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::... -
Psych
:: Nodes :: Sequence . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Sequence (109.0) -
新たな sequence オブジェクトを生成します。
新たな sequence オブジェクトを生成します。
anchor には sequence に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。
tag には sequence に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。
implicit には sequence が implicit に開始されたかどうかを
真偽値で指定します。
style には YAML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nod... -
rubygems (109.0)
-
RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。
RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。
===[a:gem_command] gem コマンドの使い方
$ gem help
RubyGems は Ruby のための高機能なパッケージ管理ツールです。
これはより多くの情報へのポインタを含んでいる基本的なヘルプメッセージです。
使用方法:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]
例:
... -
Gem
:: Package :: TarInput # load _ gemspec(io) -> Gem :: Specification | nil (103.0) -
YAML 形式の gemspec を io から読み込みます。
YAML 形式の gemspec を io から読み込みます。
@param io 文字列か IO オブジェクトを指定します。
@see Gem::Specification.from_yaml -
Psych
. load _ file(filename) -> object (103.0) -
filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。
filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。
@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
Psych
. parse _ file(filename) -> Psych :: Nodes :: Document (103.0) -
filename で指定したファイルをパースして YAML の AST を返します。
filename で指定したファイルをパースして YAML の AST を返します。
@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します -
IRB
:: Context # inspect _ mode=(opt) (91.0) -
実行結果の出力方式を 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... -
Gem
:: ConfigFile # load _ file(file _ name) -> object (85.0) -
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
@param file_name YAML 形式で記述された設定ファイル名を指定します。 -
Kernel
# psych _ y(*objects) -> String (85.0) -
objects を YAML document に変換します。
objects を YAML document に変換します。
このメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。
@param objects YAML document に変換する Ruby のオブジェクト -
Kernel
# y(*objects) -> String (85.0) -
objects を YAML document に変換します。
objects を YAML document に変換します。
このメソッドは irb 上でのみ定義されます。
syck に y メソッドがあるため、
psych_y が別名として定義されています。将来的に
syck が廃止された場合 psych_y は廃止
される予定であるため、特別の事情がない限り y を用いてください。
@param objects YAML document に変換する Ruby のオブジェクト -
Psych
:: Handler # start _ stream(encoding) -> () (85.0) -
YAML ストリームの始まりで呼び出されます。
YAML ストリームの始まりで呼び出されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。
必要に応じてこのメソッドを override してください。
@param encoding ストリームのエンコーディング(整数値) -
Psych
:: Nodes :: Document # version=(ver) (85.0) -
YAML ドキュメントのバージョンを設定します。
YAML ドキュメントのバージョンを設定します。
@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new -
Psych
. dump _ stream(*objects) -> String (67.0) -
オブジェクト列を YAML ドキュメント列に変換します。
オブジェクト列を YAML ドキュメント列に変換します。
@param objects 変換対象のオブジェクト列
//emlist[例][ruby]{
Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
//} -
Psych
:: Nodes :: Document # version -> [Integer] (67.0) -
YAML ドキュメントのバージョンを返します。
YAML ドキュメントのバージョンを返します。
@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new -
Psych
:: ScalarScanner # tokenize(string) -> object (67.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
:: Stream # start(encoding = Psych :: Nodes :: Stream :: UTF8) -> Psych :: Stream (67.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 (67.0) -
Ruby オブジェクトを YAML document に変換するための準備をします。
Ruby オブジェクトを YAML document に変換するための準備をします。
変換された document は Psych::Stream.new で指定した
出力先に出力されます。
finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。
ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。
@param encoding 出... -
Psych
:: Handler # end _ document(implicit) -> () (55.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
Psych
:: Parser . new(handler = Handler . new) -> Psych :: Parser (55.0) -
新たなパーサオブジェクトを生成して返します。
新たなパーサオブジェクトを生成して返します。
handler で YAML のイベントを処理するハンドラを指定します。
詳しくは Psych::Parser を参照してください。
@param handler YAML のイベントを処理するハンドラ -
Psych
:: Handler # alias(anchor) -> () (37.0) -
anchor という名前の alias を見付けたときに呼び出されます。
anchor という名前の alias を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。
@param anchor aliasのアンカー文字列
=== 例
以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。
--- &ponies
- first element
- *ponies
この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。 -
Psych
:: Stream . new(io) -> Psych :: Stream (37.0) -
新たな Stream オブジェクトを生成します。
新たな Stream オブジェクトを生成します。
io で YAML document の出力先を指定します。
@param io 出力先の IO オブジェクト