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

rest_sizeメソッドは、StringScannerオブジェクトが現在読み込みを進めている文字列において、現在のスキャン位置から終端までの残りの部分のバイト数を取得するメソッドです。RubyのStringScannerクラスは、文字列の内部を効率的に解析したり、特定のパターンを検索しながら読み進めたりする際に利用されます。このクラスは、文字列内における現在の読み込み位置を示す「スキャンポインタ」という概念を持っています。

rest_sizeメソッドは、このスキャンポインタが指す位置から、対象となる文字列の末尾までの間に残っている文字のバイト数を整数値で返します。具体的には、StringScannerオブジェクトが扱っている元の文字列全体のバイト数から、スキャンポインタがすでに進んだ部分のバイト数を差し引いた値に相当します。例えば、対象文字列が全部で10バイトで、すでに3バイトをスキャン済みの場合、rest_sizeメソッドは残りの7バイトを返します。

このメソッドを利用することで、まだ読み込んでいない残りの文字列の大きさを容易に把握でき、その後の文字列処理の計画を立てる際に大変役立ちます。特に、ループ処理で文字列の終端に達したかどうかを確認する条件式としてや、残りの文字列の長さに応じて異なる処理を実行したい場合などに有用です。

Copy
1require 'strscan'
2
3s = StringScanner.new("Hello Ruby world!")
4s.scan(/Hello /)
5s.rest_size # => 11 (残り "Ruby world!" のバイト数)

引数なし

引数はありません

Integer

現在スキャン位置から文字列の末尾までの長さを整数で返します。