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

beginning_of_line?メソッドは、StringScannerオブジェクトのスキャンポインタが現在の行の先頭に位置しているかを判定するメソッドです。このメソッドは、スキャン対象の文字列のどこを現在見ているかを示す「スキャンポインタ」の位置が、現在の行の冒頭にあるかどうかを調べます。具体的には、スキャンポインタの直前が改行文字（\nや\rなど）である場合、またはスキャンポインタが文字列全体の先頭（インデックス0）に位置している場合にtrueを返します。それ以外の場合、つまりスキャンポインタが文字列の途中や行の途中に存在する場合はfalseを返します。

StringScannerクラスは、与えられた文字列を効率的に走査し、正規表現や固定文字列に基づいてパターンマッチングを行うために利用されます。beginning_of_line?メソッドは、特に複数行にわたるテキストデータを扱う際に有用です。例えば、ログファイルや設定ファイルなどを行単位で解析したい場合や、行の先頭に特定のパターンが出現するかどうかを判断したい場合に活用できます。このメソッドを使うことで、スキャンポインタを移動させることなく、現在の位置情報に基づいて行の開始位置であるかを確認できるため、複雑なテキスト処理ロジックをより簡潔に記述することが可能になります。このメソッドは、スキャンポインタの位置自体は変更しません。

Copy
1require 'strscan'
2
3scanner = StringScanner.new("first line\nsecond line")
4scanner.beginning_of_line? # => true
5scanner.scan(/first line/)
6scanner.beginning_of_line? # => false
7scanner.scan(/\n/)
8scanner.beginning_of_line? # => true

引数なし

引数はありません

Boolean

現在のスキャン位置が行の先頭である場合に真（true）を返します。そうでない場合は偽（false）を返します。