検索結果

Regexp#options -> Integer (63751.0)

• 2.6.0

• インスタンスメソッド

正規表現の生成時に指定されたオプションを返します。戻り値は、 Regexp::EXTENDED, Regexp::IGNORECASE, Regexp::MULTILINE, Regexp::FIXEDENCODING, Regexp::NOENCODING, の論理和です。

正規表現の生成時に指定されたオプションを返します。戻り値は、
Regexp::EXTENDED, Regexp::IGNORECASE,
Regexp::MULTILINE,
Regexp::FIXEDENCODING,
Regexp::NOENCODING,
の論理和です。

これで得られるオプションには生成時に指定したもの以外の
オプションを含んでいる場合があります。これらのビットは
内部的に用いられているもので、Regexp.new にこれらを
渡しても無視されます。

//emlist[例][ruby]{
p Regexp::IGNORECASE # => 1
p //i.optio...

• Regexp

Net::HTTP#options(path, initheader = nil) -> Net::HTTPResponse (63673.0)

• 2.6.0

• インスタンスメソッド

サーバの path に OPTIONS リクエストを ヘッダが initheader として送り、 レスポンスを Net::HTTPResponse のオブジェクト で返します。

サーバの path に OPTIONS リクエストを
ヘッダが initheader として送り、
レスポンスを Net::HTTPResponse のオブジェクト
で返します。

@param path リクエストを送るパスを文字列で与えます。
@param initheader リクエストのヘッダを「文字列=>文字列」の
ハッシュで与えます。

@see Net::HTTP::Options

• Net::HTTP
• Net::HTTP::Options
• Net::HTTPResponse

OptionParser::Arguable#options -> OptionParser (63628.0)

• 2.6.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。

ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

//emlist[][ruby]{
require 'optparse'

o = nil
ARG...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

OptionParser::Arguable#options {|opt| ... } -> object | nil (63628.0)

• 2.6.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。

自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。

ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。

//emlist[][ruby]{
require 'optparse'

o = nil
ARG...

• OptionParser
• OptionParser::Arguable
• OptionParser::ParseError

OpenSSL::SSL::SSLContext#options -> Integer | nil (63625.0)

• 2.6.0

• インスタンスメソッド

設定されているオプションフラグを返します。

設定されているオプションフラグを返します。

@see OpenSSL::SSL::SSLContext#options=

• OpenSSL::SSL::SSLContext

絞り込み条件を変える

Rake::Application#options -> OpenStruct (63625.0)

• 2.6.0

• インスタンスメソッド

コマンドラインで与えられたアプリケーションのオプションを返します。

コマンドラインで与えられたアプリケーションのオプションを返します。

//emlist[][ruby]{
# Rakefile での記載例とする

task default: :test_rake_app
task :test_rake_app do
Rake.application.options # => #<OpenStruct always_multitask=false, backtrace=false, build_all=false, dryrun=false, ignore_deprecate=false, ignore_system=false, job_stats=...

• Rake::Application

Gem::LocalRemoteOptions#add_local_remote_options (63607.0)

• 2.6.0

• インスタンスメソッド

オプション --local, --remote, --both を追加します。

オプション --local, --remote, --both を追加します。

• Gem::LocalRemoteOptions

Rake::TestTask#options -> String (63325.0)

• 2.6.0

• インスタンスメソッド

テストスイートに渡すパラメータを返します。

テストスイートに渡すパラメータを返します。

コマンドラインで "TESTOPTS=options" が指定されると、この値を上書きします。
デフォルトは何も指定されていません。

• Rake::TestTask

Gem::Command#options -> Hash (63307.0)

• 2.6.0

• インスタンスメソッド

コマンドで使用するオプションを返します。

コマンドで使用するオプションを返します。

• Gem::Command

Rake::RDocTask#options -> Array (63307.0)

• 2.6.0

• インスタンスメソッド

rdoc コマンドに渡すオプションのリストを返します。

rdoc コマンドに渡すオプションのリストを返します。

指定できるオプションは -o, --main, --title, -T 以外です。

• Rake::RDocTask

絞り込み条件を変える

RDoc::Options#write_options -> object (45655.0)

• 2.6.0

• インスタンスメソッド

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。

• RDoc::Options

GetoptLong#set_options(*arguments) -> self (45643.0)

• 2.6.0

• インスタンスメソッド

あなたのプログラムで、認識させたいオプションをセットします。 個々のオプションは、オプション名と引数のフラグからなる配列でな ければいけません。

あなたのプログラムで、認識させたいオプションをセットします。
個々のオプションは、オプション名と引数のフラグからなる配列でな
ければいけません。

配列中のオプション名は、一文字オプション (例: -d) か長いオプ
ション (例: --debug) を表した文字列のいずれかでなければなり
ません。配列の中の一番左端のオプション名が、オプションの正式名
になります。配列中の引数のフラグは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。

オ...

• GetoptLong

Gem::InstallUpdateOptions#add_install_update_options (45607.0)

• 2.6.0

• インスタンスメソッド

インストールとアップデートに関するオプションを追加します。

インストールとアップデートに関するオプションを追加します。

• Gem::InstallUpdateOptions

RDoc::Options#include_line_numbers -> bool (45604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。

コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。

• RDoc::Options

Gem::LocalRemoteOptions#remote? -> bool (45304.0)

• 2.6.0

• インスタンスメソッド

リモートの情報を取得する場合は真を返します。 そうでない場合は偽を返します。

リモートの情報を取得する場合は真を返します。
そうでない場合は偽を返します。

• Gem::LocalRemoteOptions

絞り込み条件を変える

Gem::Command#merge_options(new_options) -> Hash (36928.0)

• 2.6.0

• インスタンスメソッド

与えられたオプションとデフォルトのオプションをマージします。 しかし、新しいオプションに同一のキーがあってもデフォルトのオプションは変更されません。

与えられたオプションとデフォルトのオプションをマージします。
しかし、新しいオプションに同一のキーがあってもデフォルトのオプションは変更されません。

@param new_options 新しいコマンドオプションをハッシュで指定します。

• Gem::Command

OpenURI::OpenRead#open(mode = &#39;r&#39;, perm = nil, options = {}) -> StringIO (36628.0)

• 2.6.0

• インスタンスメソッド

自身が表すリソースを取得して StringIO オブジェクトとして返します。 OpenURI.open_uri(self, *rest, &block) と同じです。

自身が表すリソースを取得して StringIO オブジェクトとして返します。
OpenURI.open_uri(self, *rest, &block) と同じです。

ブロックを与えた場合は StringIO オブジェクトを引数としてブロックを
評価します。ブロックの終了時に StringIO は close されます。nil を返します。

返り値である StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。

@param mode モードを文字列で与えます。Kernel.#open と同じです。

@param perm 無視されます...

• OpenURI::Meta
• OpenURI::OpenRead
• StringIO

OpenURI::OpenRead#open(mode = &#39;r&#39;, perm = nil, options = {}) {|sio| ... } -> nil (36628.0)

• 2.6.0

• インスタンスメソッド

自身が表すリソースを取得して StringIO オブジェクトとして返します。 OpenURI.open_uri(self, *rest, &block) と同じです。

自身が表すリソースを取得して StringIO オブジェクトとして返します。
OpenURI.open_uri(self, *rest, &block) と同じです。

ブロックを与えた場合は StringIO オブジェクトを引数としてブロックを
評価します。ブロックの終了時に StringIO は close されます。nil を返します。

返り値である StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。

@param mode モードを文字列で与えます。Kernel.#open と同じです。

@param perm 無視されます...

• OpenURI::Meta
• OpenURI::OpenRead
• StringIO

Gem::Command#handle_options(args) (36607.0)

• 2.6.0

• インスタンスメソッド

与えられた引数のリストをパースして結果を記録します。

与えられた引数のリストをパースして結果を記録します。

@param args 引数のリストを指定します。

• Gem::Command

Gem::LocalRemoteOptions#accept_uri_http (36304.0)

• 2.6.0

• インスタンスメソッド

HTTP の URI を扱えるようにするためのメソッドです。

HTTP の URI を扱えるようにするためのメソッドです。

• Gem::LocalRemoteOptions

絞り込み条件を変える

Gem::LocalRemoteOptions#add_bulk_threshold_option (36304.0)

• 2.6.0

• インスタンスメソッド

オプション --bulk-threshold を追加します。

オプション --bulk-threshold を追加します。

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#add_source_option (36304.0)

• 2.6.0

• インスタンスメソッド

オプション --source を追加します。

オプション --source を追加します。

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#add_update_sources_option (36304.0)

• 2.6.0

• インスタンスメソッド

オプション --update-source を追加します。

オプション --update-source を追加します。

• Gem::LocalRemoteOptions

OpenURI::OpenRead#read(options = {}) -> String (27673.0)

• 2.6.0

• インスタンスメソッド

自身が表す内容を読み込んで文字列として返します。 self.open(options={}) {|io| io.read } と同じです。 このメソッドによって返される文字列は OpenURI::Meta によって extend されています。

自身が表す内容を読み込んで文字列として返します。
self.open(options={}) {|io| io.read } と同じです。
このメソッドによって返される文字列は OpenURI::Meta
によって extend されています。

@param options ハッシュを与えます。

require 'open-uri'
uri = URI.parse('http://www.example.com/')
str = uri.read
p str.is_a?(OpenURI::Meta) # => true
p str.content_type

• OpenURI::Meta
• OpenURI::OpenRead

WEBrick::HTTPServlet::FileHandler#do_OPTIONS(request, response) -> () (27655.0)

• 2.6.0

• インスタンスメソッド

OPTIONS リクエストを処理します。

OPTIONS リクエストを処理します。

@param request クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトです。

@param response クライアントへのレスポンスを表す WEBrick::HTTPResponse オブジェクトです。

@raise WEBrick::HTTPStatus::NotFound 対象となるパスが見つからなかった場合に発生します。

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::FileHandler

絞り込み条件を変える

OpenSSL::SSL::SSLContext#options=(options) (27646.0)

• 2.6.0

• インスタンスメソッド

オプションを設定します。

オプションを設定します。

以下の値の OR で指定します。
* OpenSSL::SSL::OP_ALL
* OpenSSL::SSL::OP_CIPHER_SERVER_PREFERENCE
* OpenSSL::SSL::OP_EPHEMERAL_RSA
* OpenSSL::SSL::OP_NETSCAPE_CA_DN_BUG
* OpenSSL::SSL::OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG
* OpenSSL::SSL::OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
* OpenSS...

• OpenSSL::SSL::SSLContext

Gem::Specification#rdoc_options=(options) (27628.0)

• 2.6.0

• インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

• Gem::Specification

Rake::RDocTask#options=(options) (27628.0)

• 2.6.0

• インスタンスメソッド

rdoc コマンドに渡すオプションのリストをセットします。

rdoc コマンドに渡すオプションのリストをセットします。

@param options rdoc コマンドに渡されるオプションを指定します。

• Rake::RDocTask

RDoc::Options#coverage_report -> Integer | false (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。

コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。

指定しなかった場合は false を返します。

• RDoc::Options

RDoc::Options#encoding -> Encoding (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。

コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

• Encoding
• RDoc::Options

絞り込み条件を変える

RDoc::Options#exclude -> Regexp (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。

コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。

• RDoc::Options
• Regexp

RDoc::Options#extra_accessors -> Regexp | nil (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

指定しなかった場合は nil を返します。

• RDoc::Options

RDoc::Options#generator -> Generator (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

• RDoc::Options

RDoc::Options#option_parser -> OptionParser | nil (27604.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

• OptionParser
• RDoc::Options

OptionParser#banner=(heading) (27394.0)

• 2.6.0

• インスタンスメソッド

サマリの最初に表示される文字列を指定します。

サマリの最初に表示される文字列を指定します。

@param heading サマリの最初に表示される文字列を指定します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]" # => "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
option...

• OptionParser

絞り込み条件を変える

OptionParser#banner -> String (27376.0)

• 2.6.0

• インスタンスメソッド

サマリの最初に表示される文字列を返します。

サマリの最初に表示される文字列を返します。

@return サマリの最初に表示される文字列を返します。

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

options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"

opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end

p opts.banner # =...

• OptionParser

OptionParser::Arguable#options=(opt) (27343.0)

• 2.6.0

• インスタンスメソッド

自身をパースするための OptionParser オブジェクトをセットします。

自身をパースするための OptionParser オブジェクトをセットします。

@param opt 自身をパースする OptionParser 、あるいは nil か false を指定します。
nil か false である場合、自身の options= メソッドと options メソッドを
undef します。

• OptionParser
• OptionParser::Arguable

OptionParser#ver -> String (27322.0)

• 2.6.0

• インスタンスメソッド

program_name、version と release から生成したバージョンを表す文字列を返します。

program_name、version と release から生成したバージョンを表す文字列を返します。

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

OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"

opts.on_tail("--version", "Show v...

• OptionParser

OptionParser::Arguable#order! -> [String] (27322.0)

• 2.6.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#order! を参照して下さい。

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

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-...

• OptionParser::Arguable

OptionParser::Arguable#order! {|s| ... } -> [String] (27322.0)

• 2.6.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#order! を参照して下さい。

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

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on('-...

• OptionParser::Arguable

絞り込み条件を変える

OptionParser::Arguable#permute! -> [String] (27322.0)

• 2.6.0

• インスタンスメソッド

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#permute! を参照して下さい。

自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#permute! を参照して下さい。

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

//emlist[][ruby]{
require 'optparse'

o = nil
ARGV.options.on(...

• OptionParser::Arguable

RDoc::Options#verbosity=(val) (27322.0)

• 2.6.0

• インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で指定します。

プログラムの解析時に表示する情報の詳細さを数値で指定します。

@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。

@see RDoc::Options#verbosity

• RDoc::Options

Gem::Specification#rdoc_options -> [String] (27307.0)

• 2.6.0

• インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

• Gem::Specification

Rake::TestTask#options=(option_str) (27307.0)

• 2.6.0

• インスタンスメソッド

テストスイートに渡すパラメータをセットします。

テストスイートに渡すパラメータをセットします。

@param option_str テストスイートに渡すパラメータを指定します。

• Rake::TestTask

Gem::InstallUpdateOptions#install_update_defaults_str -> String (27304.0)

• 2.6.0

• インスタンスメソッド

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers

• Gem::InstallUpdateOptions

絞り込み条件を変える

RDoc::Options#all_one_file -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。

• RDoc::Options

RDoc::Options#charset -> String (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。

コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。

指定しなかった場合は、$KCODE に応じた値になります。

• RDoc::Options

RDoc::Options#coverage_report=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --coverage-report オプションと同様の指定を行います。

コマンドライン引数の --coverage-report オプションと同様の指定を行います。

@param val 数値オブジェクトか false を指定します。

• RDoc::Options

RDoc::Options#encoding=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --encoding オプションと同様の指定を行います。

コマンドライン引数の --encoding オプションと同様の指定を行います。

@param val 設定する Encoding オブジェクトを指定します。

• Encoding
• RDoc::Options

RDoc::Options#exclude=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --exclude オプションと同様の指定を行います。

コマンドライン引数の --exclude オプションと同様の指定を行います。

@param val 設定するパターンを Regexp オブジェクトで指定します。

• RDoc::Options
• Regexp

絞り込み条件を変える

RDoc::Options#extra_accessor_flags -> {String => String} (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

• RDoc::Options

RDoc::Options#fileboxes -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。

コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。

• RDoc::Options

RDoc::Options#files -> [String] (27304.0)

• 2.6.0

• インスタンスメソッド

解析するファイルの一覧を文字列の配列で返します。

解析するファイルの一覧を文字列の配列で返します。

• RDoc::Options

RDoc::Options#finish_page_dir (27304.0)

• 2.6.0

• インスタンスメソッド

ライブラリ内部で使用します。

ライブラリ内部で使用します。

• RDoc::Options

RDoc::Options#force_output -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。

コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は true を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#force_output=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。

@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

• RDoc::Options

RDoc::Options#force_update -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。

コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。

• RDoc::Options

RDoc::Options#formatter -> nil (27304.0)

• 2.6.0

• インスタンスメソッド

使用されていません。常に nil を返します。

使用されていません。常に nil を返します。

• RDoc::Options

RDoc::Options#formatter=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

使用されていません。

使用されていません。

• RDoc::Options

RDoc::Options#generator=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --fmt オプションと同様の指定を行います。

コマンドライン引数の --fmt オプションと同様の指定を行います。

@param val 設定する Generator を指定します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#hyperlink_all -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。

コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。

指定しなかった場合は false を返します。

• RDoc::Options

RDoc::Options#hyperlink_all=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。

@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。

• RDoc::Options

RDoc::Options#image_format -> String (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。

コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。

指定しなかった場合は 'png' を返します。

• RDoc::Options

RDoc::Options#inline_source -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。

コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。

• RDoc::Options

RDoc::Options#line_numbers -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。

コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。

どちらも指定しなかった場合は false を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#line_numbers=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。

@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。

• RDoc::Options

RDoc::Options#main_page -> String | nil (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。

コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。

指定しなかった場合は nil を返します。

• RDoc::Options

RDoc::Options#main_page=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --main オプションと同様の指定を行います。

コマンドライン引数の --main オプションと同様の指定を行います。

@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。

• RDoc::Options

RDoc::Options#merge -> true | nil (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。

コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

• RDoc::Options

RDoc::Options#op_name -> String (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。

コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#option_parser=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。

コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。

@param val OptionParser オブジェクトを指定します。

• OptionParser
• RDoc::Options

RDoc::Options#page_dir -> Pathname | nil (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。

コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。

指定されていない場合は nil を返します。

• RDoc::Options

RDoc::Options#page_dir=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --page-dir オプションと同様の指定を行います。

コマンドライン引数の --page-dir オプションと同様の指定を行います。

@param val パスを文字列で指定します。

• RDoc::Options

RDoc::Options#parse(argv) -> () (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。


また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

• RDoc::Options

RDoc::Options#pipe -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --pipe オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。

コマンドライン引数の --pipe オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#pipe=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。

val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。

@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。

• RDoc::Options

RDoc::Options#quiet -> bool (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。

コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。

• RDoc::Options

RDoc::Options#rdoc_include -> [String] (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。

コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

指定しなかった場合は ['.'] を返します。

• RDoc::Options

RDoc::Options#sanitize_path(path) (27304.0)

• 2.6.0

• インスタンスメソッド

ライブラリ内部で使用します。

ライブラリ内部で使用します。

• RDoc::Options

RDoc::Options#template -> String (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。

コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。

指定しなかった場合は 'html' を返します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#template_dir -> String | nil (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。

オプションの解析前は nil を返します。

• RDoc::Options

RDoc::Options#template_dir=(val) (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。

コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。

@param val パスを文字列で指定します。

• RDoc::Options

RDoc::Options#title -> String | nil (27304.0)

• 2.6.0

• インスタンスメソッド

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

• RDoc::Options

RDoc::Options#title=(string) (27304.0)

• 2.6.0

• インスタンスメソッド

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。

@param string 設定するタイトルを文字列で指定します。

• RDoc::Options

RDoc::Options#verbosity -> 0 | 1 | 2 (27304.0)

• 2.6.0

• インスタンスメソッド

プログラムの解析時に表示する情報の詳細さを数値で返します。

プログラムの解析時に表示する情報の詳細さを数値で返します。

以下の値を指定する事ができます。

: 0(--quiet オプションを指定した場合)

情報を表示しません。

: 1

通常の表示を行います。

: 2(--verbose オプションを指定した場合)

詳細な情報を表示します。

• RDoc::Options

絞り込み条件を変える

RDoc::Options#webcvs -> String | nil (27304.0)

• 2.6.0

• インスタンスメソッド

コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。

コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。

指定しなかった場合は nil を返します。

• RDoc::Options

Gem::LocalRemoteOptions#add_proxy_option (27004.0)

• 2.6.0

• インスタンスメソッド

オプション --http-proxy を追加します。

オプション --http-proxy を追加します。

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#both? -> bool (27004.0)

• 2.6.0

• インスタンスメソッド

ローカルとリモートの情報を両方とも取得する場合は真を返します。 そうでない場合は偽を返します。

ローカルとリモートの情報を両方とも取得する場合は真を返します。
そうでない場合は偽を返します。

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#local? -> bool (27004.0)

• 2.6.0

• インスタンスメソッド

ローカルの情報を取得する場合は真を返します。 そうでない場合は偽を返します。

ローカルの情報を取得する場合は真を返します。
そうでない場合は偽を返します。

• Gem::LocalRemoteOptions

String#encode(encoding, from_encoding, **options) -> String (19213.0)

• 2.6.0

• インスタンスメソッド

self を指定したエンコーディングに変換した文字列を作成して返します。引数 を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな くば self のエンコーディングが使われます。 無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。

self を指定したエンコーディングに変換した文字列を作成して返します。引数
を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな
くば self のエンコーディングが使われます。
無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。

@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを...

• Encoding
• Encoding::InvalidByteSequenceError
• Encoding::UndefinedConversionError
• Hash
• Method
• Proc
• String

絞り込み条件を変える

String#encode!(encoding, from_encoding, options = nil) -> self (19210.0)

• 2.6.0

• インスタンスメソッド

self を指定したエンコーディングに変換し、自身を置き換えます。引数を2つ 与えた場合、第二引数は変換元のエンコーディングを意味します。さもなくば self のエンコーディングが使われます。変換後の self を返します。

self を指定したエンコーディングに変換し、自身を置き換えます。引数を2つ
与えた場合、第二引数は変換元のエンコーディングを意味します。さもなくば
self のエンコーディングが使われます。変換後の self を返します。

(gsub!などと異なり)変換が行なわれなくても self を返します。

@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを指定します。
@param from_encoding 変換元のエンコーディングを表す文字列か Encoding オブジェクトを指定します。
@return ...

• String

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

• 2.6.0

• インスタンスメソッド

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

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

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

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

• Encoding::Converter

String#encode(encoding, **options) -> String (18913.0)

• 2.6.0

• インスタンスメソッド

self を指定したエンコーディングに変換した文字列を作成して返します。引数 を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな くば self のエンコーディングが使われます。 無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。

self を指定したエンコーディングに変換した文字列を作成して返します。引数
を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな
くば self のエンコーディングが使われます。
無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。

@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを...

• Encoding
• Encoding::InvalidByteSequenceError
• Encoding::UndefinedConversionError
• Hash
• Method
• Proc
• String

String#encode!(encoding, options = nil) -> self (18910.0)

• 2.6.0

• インスタンスメソッド

self を指定したエンコーディングに変換し、自身を置き換えます。引数を2つ 与えた場合、第二引数は変換元のエンコーディングを意味します。さもなくば self のエンコーディングが使われます。変換後の self を返します。

self を指定したエンコーディングに変換し、自身を置き換えます。引数を2つ
与えた場合、第二引数は変換元のエンコーディングを意味します。さもなくば
self のエンコーディングが使われます。変換後の self を返します。

(gsub!などと異なり)変換が行なわれなくても self を返します。

@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを指定します。
@param from_encoding 変換元のエンコーディングを表す文字列か Encoding オブジェクトを指定します。
@return ...

• String

OptionParser#separator(sep) -> () (18676.0)

• 2.6.0

• インスタンスメソッド

サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。

サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。

@param sep サマリの区切りを文字列で指定します。

//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"

opts.separator ""
opts.separator...

• OptionParser

絞り込み条件を変える

CGI#header(options = "text/html") -> String (18673.0)

• 2.6.0

• インスタンスメソッド

HTTP ヘッダを options に従って生成します。 CGI#out と違い、標準出力には出力しません。 CGI#out を使わずに自力で HTML を出力したい場合などに使います。 このメソッドは文字列エンコーディングを変換しません。

HTTP ヘッダを options に従って生成します。 CGI#out と違い、標準出力には出力しません。
CGI#out を使わずに自力で HTML を出力したい場合などに使います。
このメソッドは文字列エンコーディングを変換しません。

ヘッダのキーとしては以下が利用可能です。

: type
Content-Type ヘッダです。デフォルトは "text/html" です。
: charset
ボディのキャラクタセットを Content-Type ヘッダに追加します。
: nph
真偽値を指定します。真ならば、HTTP のバージョン、ステータスコード、
Date ヘッ...

• CGI
• CGI::Cookie
• Hash
• Time

String#parse_csv(**options) -> [String] (18673.0)

• 2.6.0

• インスタンスメソッド

CSV.parse_line(self, options) と同様です。

CSV.parse_line(self, options) と同様です。

1 行の CSV 文字列を、文字列の配列に変換するためのショートカットです。

@param options CSV.new と同様のオプションを指定します。

//emlist[][ruby]{
require "csv"

p "Matz,Ruby\n".parse_csv # => ["Matz", "Ruby"]
p "Matz|Ruby\r\n".parse_csv(col_sep: '|', row_sep: "\r\n") # => ...

• CSV.parse_line
• String

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

• 2.6.0

• インスタンスメソッド

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

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

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、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 (18643.0)

• 2.6.0

• インスタンスメソッド

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

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

可搬性を確保しつつ、不正なバイトや変換先で未定義な文字の扱いを細かに指定したいときは、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 (18643.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

• Encoding::Converter

絞り込み条件を変える