class URI::FTP (Ruby 3.0 リファレンスマニュアル)

このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。最新版のマニュアルへ

dynamic include: OpenURI::OpenRead (by open-uri)

要約

FTP URI を表すクラスです。

継承しているメソッド

URI::Genericから継承している特異メソッド

URI::Genericから継承しているメソッド

動的includeで追加されるメソッド

OpenURI::OpenRead (by open-uri)

open
read

特異メソッド

build(ary) -> URI::FTP[permalink][rdoc][edit]

build(hash) -> URI::FTP

引数で与えられた URI 構成要素から URI::FTP オブジェクトを生成します。引数の正当性を検査します。

例

require 'uri'
p URI::FTP.build([nil, "www.example.com", 10020, "/path",  'a'])
#=> #<URI::FTP:0x201c4f9c URL:ftp://www.example.com:10020/path;type=a>
  
p URI::FTP.build({:host => "www.example.com", :path => "/path",  :typecode => 'a'})
#=> #<URI::FTP:0x201bd9cc URL:ftp://www.example.com/path;type=a>
  
p URI::FTP.build([nil, 'example.com', nil, '/foo', 'i']).to_s
#=> 'ftp://example.com/%2Ffoo;type=i'

[PARAM] ary:

構成要素を表す文字列の配列を与えます。要素は

      [userinfo, host, port, path, typecode]

の順です。typecode は、"a"、"i" あるいは "d" です。"a" はテキスト、"i" はバイナリ、 "d" はディレクトリを表します。"a" がテキストで、"i" がバイナリなのは、それぞれのデータタイプがFTPのプロトコルで ASCII と IMAGE と呼ばれていたためです。

[PARAM] hash:

構成要素を表すハッシュを与えます。ハッシュのキーは

 :scheme, :userinfo, :host, :port, :path, :typecode

のいずれかです。ハッシュの値は文字列です。typecode は、 "a"、"i" あるいは "d" です。"a" はテキスト、"i" はバイナリ、 "d" はディレクトリを表します。"a" がテキストで、"i" がバイナリなのは、それぞれのデータタイプがFTPのプロトコルで ASCII と IMAGE と呼ばれていたためです。

[EXCEPTION] URI::InvalidComponentError:

各要素が適合しない場合に発生します。

[EXCEPTION] ArgumentError:

typecode に定められた以外の文字を与えると発生します。

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, arg_check = false) -> URI::FTP[permalink][rdoc][edit]

汎用的な構成要素から URI::FTP オブジェクトを生成します。build と異なり、デフォルトでは引数の正当性を検査しません。

例

require 'uri'
p ftp = URI.parse("ftp://ftp.ruby-lang.org/pub/ruby/;type=d")
p ftp.typecode
#=> #<URI::FTP:0x2010029c URL:ftp://ftp.ruby-lang.org/pub/ruby/;type=d>
#=> "d"

[PARAM] scheme:: 構成要素を表す文字列を与えます。
[PARAM] userinfo:: 構成要素を表す文字列を与えます。
[PARAM] host:: 構成要素を表す文字列を与えます。
[PARAM] port:: 構成要素を表す文字列を与えます。
[PARAM] registry:: nil を与えます。
[PARAM] path:: 構成要素を表す文字列を与えます。
[PARAM] opaque:: 構成要素を表す文字列を与えます。
[PARAM] query:: 構成要素を表す文字列を与えます。
[PARAM] fragment:: 構成要素を表す文字列を与えます。
[PARAM] arg_check:: 真が与えられた場合は、各引数が字句規則に適合しているか否かを検査します。適合しない場合は例外 URI::InvalidComponentError が起ります。
[EXCEPTION] URI::InvalidURIError:: registry に nil 以外を与えた時に発生します。引数の正当性は、これ以外デフォルトでは検査しません。
[EXCEPTION] URI::InvalidComponentError:: 各要素が適合しない場合に発生します。

new2(user, password, host, port, path, typecode = nil, arg_check = true) -> URI::FTP[permalink][rdoc][edit]

URI::FTP オブジェクトを生成して返します。引数の正当性を検査します。

[PARAM] user:: 構成要素を表す文字列を与えます。
[PARAM] password:: 構成要素を表す文字列を与えます。
[PARAM] host:: 構成要素を表す文字列を与えます。
[PARAM] port:: 構成要素を表す文字列を与えます。
[PARAM] path:: 構成要素を表す文字列を与えます。
[PARAM] typecode:: 構成要素を表す文字列を与えます。
[PARAM] arg_check:: 真が与えられた場合は、各引数が字句規則に適合しているか否かを検査します。適合しない場合は例外 URI::InvalidComponentError が起ります。
[EXCEPTION] ArgumentError:: typecode が正当でなかった場合に発生します。
[EXCEPTION] URI::InvalidURIError:: 引数が invalid な場合に発生します。

インスタンスメソッド

typecode -> String | nil[permalink][rdoc][edit]

ファイル転送のタイプを文字列で返します。"a" はテキスト、"i" はバイナリ、"d" はディレクトリを表します。設定されていない場合は nil を返します。

typecode=(t)[permalink][rdoc][edit]

ファイル転送のタイプを文字列で指定します。

[PARAM] t:: ファイル転送のタイプを文字列で指定します。"a" はテキスト、"i" はバイナリ、"d" はディレクトリを表します。
[EXCEPTION] URI::InvalidComponentError:: 不正な引数 s に対して発生します。

要約

目次

継承しているメソッド

動的includeで追加されるメソッド

特異メソッド

インスタンスメソッド