Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > iconvライブラリ > Iconv::IllegalSequenceクラス

class Iconv::IllegalSequence + Iconv::Failure + ArgumentError + StandardError + Exception

クラスの継承リスト: Iconv::IllegalSequence < Iconv::Failure < ArgumentError < StandardError < Exception < Object < Kernel

要約

入力か出力の文字が指示された文字集合に含まれないために変換が停止したこと を表します。

特異メソッド

new(error_message = nil) -> Exception
exception(error_message = nil) -> Exception

例外オブジェクトを生成して返します。

[PARAM] error_message:
エラーメッセージを表す文字列を指定します。このメッセージは 属性 Exception#message の値になり、デフォルトの例外ハンドラで表示されます。

インスタンスメソッド

backtrace -> [String]

バックトレース情報を返します。

デフォルトでは

  • "#{sourcefile}:#{sourceline}:in `#{method}'" (メソッド内の場合)
  • "#{sourcefile}:#{sourceline}" (トップレベルの場合)

という形式の String の配列です。 

def methd
  raise
end

begin
  methd
rescue => e
  p e.backtrace
end

#=> ["filename.rb:2:in `methd'", "filename.rb:6"]
exception -> self
exception(error_message) -> Exception

引数を指定しない場合は self を返します。引数を指定した場合 自身のコピー を生成し Exception#message 属性を error_message にして返します。

Kernel.#raise は、実質的に、例外オブジェクトの exception メソッドの呼び出しです。

[PARAM] error_message:
エラーメッセージを表す文字列を指定します。 
begin
 ...        # 何か処理
rescue => e
 raise e.exception("an error occurs during hogehoge process")  # 詳しいエラーメッセージ
end
failed -> String | Array

Iconv が起こす例外が発生した位置から最後までの文字列を返します。

Iconv.iconv でこの例外が起こったときに返される値は、 変換対象の文字列の配列のうち、変換が失敗した文字列の変換が失敗した位置から最後までの文字列と以降の文字列の配列を返します。

inspect -> String

Iconv が起こす例外が起きた場合の情報を

#<"例外の種類": "例外が発生するまでに変換した文字列", "例外が起こった位置から最後までの文字列">

のような形式の文字列として返します。

message -> String
to_s -> String
to_str -> String

エラーメッセージをあらわす文字列を返します。 

begin
  1 + nil
rescue => e
  p e.message   #=>  "nil can't be coerced into Fixnum"
end
set_backtrace(errinfo) -> nil | String | [String]

バックトレース情報に errinfo を設定し、設定されたバックトレース 情報を返します。

[PARAM] errinfo:
nil、String あるいは String の配列のいずれかを指定します。
success -> String | Array

Iconv が起こす例外が発生するまで変換が成功した文字列を返します。

Iconv.iconv でこの例外が起こったときに返される値は、 以前の例外が起こるまでに変換に成功した文字列を要素とする配列です。 最後の要素は変換中の文字列です。

class Iconv::IllegalSequence