るりまサーチ

最速Rubyリファレンスマニュアル検索！
803件ヒット [1-100件を表示] （0.095秒）
トップページ > 種類:インスタンスメソッド[x] > クエリ:OptionParser[x]

別のキーワード

  1. optionparser on
  2. optionparser order
  3. optionparser getopts
  4. optionparser new
  5. optionparser parse

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. OptionParser#on(long, klass = String, desc = "") {|v| ...} -> self
  2. OptionParser#on(short, klass = String, desc = "") {|v| ...} -> self
  3. OptionParser#on(short, long, klass = String, desc = "") {|v| ...} -> self
  4. OptionParser#on_tail(*arg, &block) -> self
  5. OptionParser#parse!(argv = self.default_argv, into: nil) -> [String]
<< 1 2 3 ... > >>

OptionParser#on(long, klass = String, desc = "") {|v| ...} -> self (21046.0)

  • インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...
...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...
...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

OptionParser#on(short, klass = String, desc = "") {|v| ...} -> self (21046.0)

  • インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...
...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...
...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

OptionParser#on(short, long, klass = String, desc = "") {|v| ...} -> self (21046.0)

  • インスタンスメソッド

オプションを取り扱うためのブロックを自身に登録します。 ブロックはコマンドラインのパース時に、オプションが指定されていれば呼ばれます。

...なクラスを受け付けるかは、
以下の「デフォルトで利用可能な引数クラス」を参照して下さい。
OptionParser.accept や OptionParser#accept によって、受け付け
るクラスを増やすことができます。登録されていないクラスが指定され...
...外 ArgumentError を投げます。
また、登録されたクラスであっても引数が変換できないものである場合、例外
OptionParser::InvalidArgument を投げます。

オプションの引数は accept で登録したブロックで klass のインスタンス
に変換さ...
...の引数は変換されません。

: String
オプションの引数は変換されません。ただし、空文字列を指定すると
OptionParser::InvalidArgument が発生します。

: Integer
Integer オブジェクトに変換されます。"0b1"、"07"、"99"、"0xff" といった...

OptionParser#on_tail(*arg, &block) -> self (21043.0)

  • インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。

...明をサマリの最後に表示したい時に便利です。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opt...
..., --help
//}

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new
opts.on_tail("-h", "--help", "Show this message") do
puts opts
exit
end

opts.on_tail("--version", "Show version") do
puts OptionParser::Version.join('.')
exit
end
//}

@see OptionParser#on, OptionParser#on_head...

OptionParser#parse!(argv = self.default_argv, into: nil) -> [String] (21037.0)

  • インスタンスメソッド

与えられた argv をパースします。

...与えられた argv をパースします。

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts...

絞り込み条件を変える

OptionParser#parse(*args, into: nil) -> [String] (21037.0)

  • インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts...

OptionParser#parse(argv, into: nil) -> [String] (21037.0)

  • インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...
...ョンを格納するハッシュを指定します。
指定したハッシュにはオプションの名前をキーとして、OptionParser#onに渡されたブロックの値が格納されます。
キーの名前はロングオプションが定義されていればロ...
...。

@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts...

OptionParser#on_head(*arg, &block) -> self (21031.0)

  • インスタンスメソッド

オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。

...ックを自身の持つリストの最初に登録します。

@param arg OptionParser#on と同様です。

@param block OptionParser#on と同様です。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opt...
...s.on_tail("-h", "--help")
end

puts opts.help

# => Usage: test [options]
# -i, --init
# -u, --update
# -h, --help
//}

@see OptionParser#on, OptionParser#on_tail...

OptionParser#parse!(argv = self.default_argv) -> [String] (21031.0)

  • インスタンスメソッド

与えられた argv をパースします。

...

OptionParser#permute! と同様に argv を破壊的にパースします。
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order! と同様に振舞います。

@param argv パースしたい引数を文字列の配列で指定します。


@raise OptionParser...
...た場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update...

OptionParser#parse(*args) -> [String] (21031.0)

  • インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...
...。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opt...

絞り込み条件を変える

OptionParser#parse(argv) -> [String] (21031.0)

  • インスタンスメソッド

与えられた argv をパースします。 argv からオプションを取り除いたものを返します。

...す。
argv からオプションを取り除いたものを返します。

OptionParser#permute と同様に振舞います。しかし、
環境変数に POSIXLY_CORRECT が設定されている場合は、
OptionParser#order と同様に振舞います。

@param argv パースしたい引数を...
...。


@raise OptionParser::ParseError パースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスになります。

//emlist[例][ruby]{
require "optparse"

opts = OptionParser.new do |opt...

OptionParser#accept(klass, pat = /.*/) {|str| ...} -> () (21029.0)

  • インスタンスメソッド

OptionParser.accept と同様ですが、 登録したブロックはレシーバーに限定されます。

...
OptionParser.accept と同様ですが、
登録したブロックはレシーバーに限定されます。

@param klass クラスオブジェクトを与えます。

@param pat match メソッドを持ったオブジェクト(Regexp オブジェクトなど)を与えます。

//emlist[例][rub...
...y]{
require "optparse"
require "time"

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

opts.on("-t", "--time [TIME]", Time) do |time|
p time.class # => Time
end

opts.parse!(ARGV)
//}...

OptionParser#reject(klass) -> () (21029.0)

  • インスタンスメソッド

OptionParser#accept で登録したクラスとブロックを 自身から削除します。

...
OptionParser#accept で登録したクラスとブロックを
自身から削除します。

@param klass 自身から削除したいクラスを指定します。

//emlist[例][ruby]{
require "optparse"
require "time"

def parse(option_parser)
option_parser.on("-t", "--time [TIME]", Time) do...
...|time|
p time.class
end
option_parser.parse(ARGV)
end

opts = OptionParser.new
opts.accept(Time) do |s,|
begin
Time.parse(s) if s
rescue
raise OptionParser::InvalidArgument, s
end
end

parse(opts) # => Time
opts.reject(Time)
parse(opts) # => unsupported argument type: Time (Arg...
<< 1 2 3 ... > >>

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 13.0.0 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。