Ruby 4.0 リファレンスマニュアル

instance method OptionParser#getopts

getopts(argv, *opts, symbolize_names: false, exact: self.require_exact) -> Hash[permalink][rdoc][edit]
getopts(*opts, symbolize_names: false, exact: self.require_exact) -> Hash

引数をパースした結果を、Hash として返します。

配列 argv を与えた場合、argv をパースします。そうでない場合は、 default_argv をパースします。

opt = OptionParser.new
params = opt.getopts(ARGV, "ab:", "foo", "bar:")
# params["a"] = true   # -a
# params["b"] = "1"    # -b1
# params["foo"] = true  # --foo
# params["bar"] = "x"  # --bar x
[PARAM] argv:
パースしたい配列を指定します。
[PARAM] opts:
引数を文字列で指定します。
[PARAM] symbolize_names:
true を指定すると、戻り値の Hash はキーがシンボルになります。false を指定した場合、戻り値の Hash はキーが文字列になります。
[PARAM] exact:
真を指定すると、ロングオプションを省略した形(OptionParser#require_exact を参照)を受け付けなくなります。省略時は OptionParser#require_exact の値です。
[EXCEPTION] OptionParser::ParseError:
パースに失敗した場合、発生します。実際は OptionParser::ParseError のサブクラスになります。