Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】StringIO::truncate()メソッドの使い方

truncateメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

truncateメソッドは、StringIOオブジェクトが保持する文字列データの長さを指定されたバイト数に変更するメソッドです。StringIOクラスは、メモリ上の文字列データをあたかもファイルであるかのように扱うことを可能にするため、一時的なデータ操作やテストコードなどで頻繁に利用されます。

このメソッドは、変更後の新しい文字列の長さをバイト単位で指定するlengthという引数を一つ受け取ります。もし、指定されたlengthが現在の文字列データの長さよりも短い場合、文字列は指定されたlengthで切り詰められ、それ以降のデータは破棄されます。逆に、指定されたlengthが現在の文字列データの長さよりも長い場合、文字列は指定されたlengthまでヌル文字(\0)で埋められて拡張されます。

truncateメソッドの実行は、StringIOオブジェクト内の読み書き位置(ポインタ)には影響を与えません。つまり、メソッド実行後も以前の読み書き位置が保持されます。このメソッドは、呼び出し元のStringIOオブジェクト自身を返します。これにより、メソッドチェーンを構築することも可能です。

一時的なバッファのサイズを調整したり、特定の固定長フォーマットに合わせてデータを準備したりする際に、このtruncateメソッドは非常に役立ちます。メモリ上で効率的かつ柔軟に文字列データを管理するための重要な機能の一つです。

構文(syntax)

1require 'stringio'
2
3sio = StringIO.new("This is a test string.")
4sio.truncate(10)

引数(parameters)

length

  • length: Integer: StringIOオブジェクトの末尾から指定されたバイト数だけを保持し、それより後ろのデータは切り捨てるために使用する整数。

戻り値(return)

Integer

StringIOオブジェクトの長さを指定されたサイズに切り詰めた後の、実際の長さを整数で返します。

関連コンテンツ

関連プログラミング言語