【Ruby3.x】IO::Buffer::pwrite()メソッドの使い方

pwriteメソッドは、IO::Bufferオブジェクトが管理するメモリ領域の特定の位置にデータを書き込むメソッドです。IO::Bufferは、メモリ上でバイナリデータを効率的に操作するためにRuby 3から導入されたクラスであり、このpwriteメソッドはそのバッファ内の任意の位置に、既存のデータを上書きする形で新しいデータを書き込む際に使用されます。

このメソッドは主に二つの引数を必要とします。一つ目は書き込みたいデータそのもので、これは通常の文字列オブジェクトか、あるいは別のIO::Bufferオブジェクトとして指定できます。二つ目は、データの書き込みを開始するIO::Buffer内の位置を示すオフセット値で、バイト単位で指定します。

指定されたデータは、このオフセットで示された位置から順にバッファへ書き込まれます。重要な点として、もし書き込むデータのサイズがIO::Bufferの現在のサイズを超えてしまう場合でも、バッファ自体のサイズは自動的に拡張されません。代わりに、バッファの終端を超えるデータは切り捨てられます。また、もしオフセット値がIO::Bufferの現在の終端よりも大きい位置を指定した場合、エラーが発生するため注意が必要です。メソッドは、実際にIO::Bufferへ書き込まれたバイト数を整数値で返します。これにより、メモリバッファの特定部分をピンポイントで更新する柔軟な操作が可能となります。

Copy
1buffer.pwrite(string, offset)

string_or_buffer, offset, length = nil, src_offset = 0

• string_or_buffer: 書き込む文字列またはバッファを指定します
• offset: 書き込みを開始する位置をバイト単位で指定します
• length = nil: 書き込むバイト数を指定します。nil の場合は string_or_buffer の全体を書き込みます
• src_offset = 0: string_or_buffer のどこから書き込みを開始するかをバイト単位で指定します

Integer

pwriteメソッドは、指定されたオフセット位置にデータを書き込んだバイト数を整数で返します。