検索結果

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

• 2.3.0

• インスタンスメソッド

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

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

• Gem::Command

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

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

• 2.3.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

Gem::InstallUpdateOptions#add_install_update_options (54607.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::InstallUpdateOptions

Gem::LocalRemoteOptions#add_local_remote_options (45607.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::LocalRemoteOptions

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Gem::Specification

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

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

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Gem::Command

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

• 2.3.0

• インスタンスメソッド

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

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

• Gem::Specification

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Gem::InstallUpdateOptions

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Gem::Command

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

WEBrick::HTTPServlet::AbstractServlet#do_OPTIONS(request, response) -> () (27607.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Encoding
• RDoc::Options

Gem::LocalRemoteOptions#add_bulk_threshold_option (27304.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#add_proxy_option (27304.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#add_source_option (27304.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::LocalRemoteOptions

Gem::LocalRemoteOptions#add_update_sources_option (27304.0)

• 2.3.0

• インスタンスメソッド

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

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

• Gem::LocalRemoteOptions

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• Encoding
• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options
• Regexp

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options
• Regexp

RDoc::Options#finish_page_dir (27304.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。

@return 設定されたディレクトリを文字列で返します。

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

@param val 設定するディレクトリを文字列で指定します。

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

RDoc::Options#tab_width -> Integer (27304.0)

• 2.3.0

• インスタンスメソッド

コマンドライン引数の --tab-width オプションで指定した数値を返します。

コマンドライン引数の --tab-width オプションで指定した数値を返します。

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.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

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

• 2.3.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

ARGF.class#set_encoding(enc_str, options = {}) -> self (18628.0)

• 2.3.0

• インスタンスメソッド

ARGF の外部／内部エンコーディングを設定します。 次以降に処理するファイルにも同じ設定が適用されます。

ARGF の外部／内部エンコーディングを設定します。
次以降に処理するファイルにも同じ設定が適用されます。

外部エンコーディングは ARGF を介して読み込むファイルの、
内部エンコーディングは読み込んだ文字列のエンコーディングです。

詳しくは IO#set_encoding を参照してください。

@param enc_str 外部／内部エンコーディングを"A:B" のようにコロンで
区切って指定します。
@param ext_enc 外部エンコーディングを表す文字列か
Encoding オブジェクトを指定します。
@para...

• ARGF.class

ARGF.class#set_encoding(ext_enc, int_enc, options = {}) -> self (18628.0)

• 2.3.0

• インスタンスメソッド

ARGF の外部／内部エンコーディングを設定します。 次以降に処理するファイルにも同じ設定が適用されます。

ARGF の外部／内部エンコーディングを設定します。
次以降に処理するファイルにも同じ設定が適用されます。

外部エンコーディングは ARGF を介して読み込むファイルの、
内部エンコーディングは読み込んだ文字列のエンコーディングです。

詳しくは IO#set_encoding を参照してください。

@param enc_str 外部／内部エンコーディングを"A:B" のようにコロンで
区切って指定します。
@param ext_enc 外部エンコーディングを表す文字列か
Encoding オブジェクトを指定します。
@para...

• ARGF.class

絞り込み条件を変える

String#encode(**options) -> String (18613.0)

• 2.3.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) -> String (18613.0)

• 2.3.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) -> String (18613.0)

• 2.3.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 (18610.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

• String

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

• 2.3.0

• インスタンスメソッド

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

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

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

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

• String

絞り込み条件を変える

Gem::Command#add_option(*opts) {|value, options| ... } (18607.0)

• 2.3.0

• インスタンスメソッド

コマンドに対するコマンドラインオプションとハンドラを追加します。

コマンドに対するコマンドラインオプションとハンドラを追加します。

ブロックには、コマンドライン引数の値とそのオプションが渡されます。
オプションはハッシュになっています。

@param opts オプションを指定します。

@see OptionParser#make_switch

• Gem::Command

OptionParser#load(filename = nil) -> bool (18448.0)

• 2.3.0

• インスタンスメソッド

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。

パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。

@param filename 各行をパースしたいファイルの名前を文字列で指定します。
指定されないか nil である場合、~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。

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

• OptionParser

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

• 2.3.0

• インスタンスメソッド

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

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

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

オ...

• GetoptLong

Psych::Nodes::Node#to_yaml(io=nil, options={}) -> String | IO (18346.0)

• 2.3.0

• インスタンスメソッド

AST を YAML ドキュメントに変換します。

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。

options には以下が指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

• IO
• Psych::Nodes::Node
• Psych::Nodes::Stream

Psych::Nodes::Node#yaml(io=nil, options={}) -> String | IO (18346.0)

• 2.3.0

• インスタンスメソッド

AST を YAML ドキュメントに変換します。

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。

options には以下が指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

• IO
• Psych::Nodes::Node
• Psych::Nodes::Stream

絞り込み条件を変える

ARGF.class#set_encoding(ext_enc) -> self (18328.0)

• 2.3.0

• インスタンスメソッド

ARGF の外部／内部エンコーディングを設定します。 次以降に処理するファイルにも同じ設定が適用されます。

ARGF の外部／内部エンコーディングを設定します。
次以降に処理するファイルにも同じ設定が適用されます。

外部エンコーディングは ARGF を介して読み込むファイルの、
内部エンコーディングは読み込んだ文字列のエンコーディングです。

詳しくは IO#set_encoding を参照してください。

@param enc_str 外部／内部エンコーディングを"A:B" のようにコロンで
区切って指定します。
@param ext_enc 外部エンコーディングを表す文字列か
Encoding オブジェクトを指定します。
@para...

• ARGF.class

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

• 2.3.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")
opts.on_tail("-h", "--help")
end

puts opts.help

# => ...

• OptionParser

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

• 2.3.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] (18322.0)

• 2.3.0

• インスタンスメソッド

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

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

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

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

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

• OptionParser::Arguable

Rake::FileTask#needed? -> bool (18322.0)

• 2.3.0

• インスタンスメソッド

このタスクが必要である場合は真を返します。 そうでない場合は偽を返します。

このタスクが必要である場合は真を返します。
そうでない場合は偽を返します。

このタスクで作成しようとしているファイルが存在しない場合や、
このタスクで作成しようとしているファイルが古い場合に真を返します。

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

task default: "test.txt"
file "test.txt" do |task|
Rake.application.options.build_all = false
task.needed? # => true
IO.write("test.txt", "test")
t...

• Rake::FileTask

絞り込み条件を変える

WEBrick::HTTPServlet::AbstractServlet#do_DELETE(request, response) -> () (18307.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

WEBrick::HTTPServlet::AbstractServlet#do_GET(request, response) -> () (18307.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

WEBrick::HTTPServlet::AbstractServlet#do_HEAD(request, response) -> () (18307.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

WEBrick::HTTPServlet::AbstractServlet#do_POST(request, response) -> () (18307.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

WEBrick::HTTPServlet::AbstractServlet#do_PUT(request, response) -> () (18307.0)

• 2.3.0

• インスタンスメソッド

自身の service メソッドから HTTP のリクエストに応じて 呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し なければいけません。返り値は特に規定されていません。

自身の service メソッドから HTTP のリクエストに応じて
呼ばれるメソッドです。AbstractServlet のサブクラスはこれらのメソッドを適切に実装し
なければいけません。返り値は特に規定されていません。

クライアントが使う可能性のある RFC で定義された HTTP のメソッドはすべて実装する必要があります。
クライアントからのリクエストに使われないと分かっているメソッドは実装しなくてもかまいません。
実装されていない HTTP メソッドであった場合、自身の service メソッドが
例外を発生させます。

このメソッドが呼ばれた時点では、クライアントからのリクエスト...

• WEBrick::HTTPRequest
• WEBrick::HTTPResponse
• WEBrick::HTTPServlet::AbstractServlet

絞り込み条件を変える

RDoc::Options#visibility -> :public | :protected | :private (18304.0)

• 2.3.0

• インスタンスメソッド

コマンドライン引数の --visibility で指定したオプションを Symbol で返します。

コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。

• RDoc::Options
• Symbol

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

• 2.3.0

• インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

RDoc::Options#css -> String (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

使用されていません。

使用されていません。

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

絞り込み条件を変える

RDoc::Options#markup -> String (18004.0)

• 2.3.0

• インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。

コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

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

• RDoc::Options

RDoc::Options#markup=(val) (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

@param val フォーマットを文字列で指定します。

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• OptionParser
• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

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

• OptionParser
• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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


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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

RDoc::Options#promiscuous (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

RDoc::Options#root -> Pathname (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

指定されていない場合はカレントディレクトリを返します。

• RDoc::Options

RDoc::Options#root=(val) (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• RDoc::Options

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

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

RDoc::Options#show_all -> bool (18004.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Options

絞り込み条件を変える