Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Encoding::InvalidByteSequenceErrorクラス

class Encoding::InvalidByteSequenceError + EncodingError + StandardError + Exception

クラスの継承リスト: Encoding::InvalidByteSequenceError < EncodingError < StandardError < Exception < Object < Kernel < BasicObject

要約

文字列がそのエンコーディングにおいて不正なバイト列である場合に発生 する例外。

通常エンコーディング変換時に発生します。 

"\x82\xa0".force_encoding("cp932").encode("UTF-8")
#=> "あ"
"\x82\xa0".force_encoding("EUC-JP").encode("UTF-8")
#=> Encoding::InvalidByteSequenceError: "\x82" on EUC-JP

特異メソッド

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

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

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

インスタンスメソッド

self == other -> bool

自身と指定された other のクラスが同じであり、message と backtrace が == メソッドで比較して 等しい場合に true を返します。そうでない場合に false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
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"]
destination_encoding -> Encoding

エラーを発生させた変換の変換先のエンコーディングを Encoding オブジェクトで返します。

[SEE_ALSO] Encoding::InvalidByteSequenceError#source_encoding, Encoding::UndefinedConversionError#destination_encoding

destination_encoding_name -> String

エラーを発生させた変換の変換先のエンコーディングを文字列で返します。

[SEE_ALSO] Encoding::InvalidByteSequenceError#destination_encoding

error_bytes -> String

エラー発生時に捨てられたバイト列を返します。 

ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")
begin
  ec.convert("abc\xA1\xFFdef")
rescue Encoding::InvalidByteSequenceError
  p $!
  #=> #<Encoding::InvalidByteSequenceError: "\xA1" followed by "\xFF" on EUC-JP>
  puts $!.error_bytes.dump          #=> "\xA1"
  puts $!.readagain_bytes.dump      #=> "\xFF"
end

[SEE_ALSO] Encoding::InvalidByteSequenceError#readagain_bytes

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
incomplete_input? -> bool

エラー発生時に入力文字列が不足している場合に真を返します。

つまり、マルチバイト文字列の途中で文字列が終わっている場合に 真を返します。これは後続の入力を追加することでエラーが 解消する可能性があることを意味します。 

ec = Encoding::Converter.new("EUC-JP", "ISO-8859-1")

begin
  ec.convert("abc\xA1z")
rescue Encoding::InvalidByteSequenceError
  p $!
  #=> #<Encoding::InvalidByteSequenceError: "\xA1" followed by "z" on EUC-JP>
  p $!.incomplete_input?    #=> false
end

begin
  ec.convert("abc\xA1")
  ec.finish
rescue Encoding::InvalidByteSequenceError
  p $! #=> #<Encoding::InvalidByteSequenceError: incomplete "\xA1" on EUC-JP>
  p $!.incomplete_input?    #=> true
end
message -> String
to_s -> String

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

begin
  1 + nil
rescue => e
  p e.message   #=>  "nil can't be coerced into Fixnum"
end
readagain_bytes -> String

エラー発生時に読み直さなければならないバイト列を返します。

[SEE_ALSO] Encoding::InvalidByteSequenceError#error_bytes

set_backtrace(errinfo) -> nil | String | [String]

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

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

エラーを発生させた変換の変換元のエンコーディングを Encoding オブジェクトで返します。

[SEE_ALSO] Encoding::InvalidByteSequenceError#destination_encoding, Encoding::UndefinedConversionError#source_encoding

source_encoding_name -> Encoding

エラーを発生させた変換の変換元のエンコーディングを文字列で返します。

[SEE_ALSO] Encoding::InvalidByteSequenceError#source_encoding

class Encoding::InvalidByteSequenceError