【Ruby3.x】Encoding::Converter::convert()メソッドの使い方

convertメソッドは、異なる文字エンコーディング間での文字列変換を実行するメソッドです。このメソッドは、RubyのEncoding::Converterクラスに属しており、事前に設定された入力エンコーディングから指定された出力エンコーディングへの実際の変換処理を行います。

Encoding::Converterは、与えられた文字列データを内部的にバッファリングし、このconvertメソッドが呼び出されるたびに、バッファ内のデータを処理してエンコーディングを変換します。変換は一度に全てのデータを処理するのではなく、必要に応じて複数回呼び出すことで段階的に実行することが可能です。

特に重要なのは、引数としてEOF（End Of File）フラグを受け取ることです。このEOFフラグをtrueに設定してconvertメソッドを呼び出すと、Converterは入力データの終端に達したと判断し、それまでに内部に保持していたすべての未処理データを強制的に変換し、出力としてフラッシュします。これにより、変換処理の完了時にデータが欠落することなく、完全に変換された結果を得ることができます。

この機能は、ファイルの内容を読み込んだり、ネットワークからデータをストリーミング受信したりする際に、大量のテキストデータのエンコーディングを効率的かつ確実に変換する場面で非常に役立ちます。例えば、Shift_JISで書かれたファイルをUTF-8に変換する場合などに利用され、文字化けを防ぎ、データの互換性を保つ上で不可欠な役割を果たします。

Copy
1converter = Encoding::Converter.new("UTF-8", "ISO-2022-JP")
2source_string = "変換対象の文字列".encode("UTF-8")
3output_buffer = ""
4converter.convert(source_string, output_buffer)

src, dst, finish = false

• src: 変換元のエンコーディングを指定します。Encodingオブジェクト、またはエンコーディング名を文字列で指定します。
• dst: 変換先のエンコーディングを指定します。Encodingオブジェクト、またはエンコーディング名を文字列で指定します。
• finish = false: 変換処理の終了を指示します。true を指定すると、残りのバッファもまとめて変換して処理を終了します。

Integer

指定されたエンコーディングに変換する際に、実際に変換されたバイト数を返します。