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

exist?メソッドは、RubyのStringScannerクラスにおいて、現在のスキャン位置から指定されたパターンが存在するかどうかを判定するメソッドです。

StringScannerクラスは、文字列を効率的に解析したり、特定のパターンを検索しながら読み進めたりするための便利なツールです。このクラスは、対象となる文字列とその文字列内で現在どこを読み取っているかを示す内部的なスキャン位置（ポインタ）を保持しています。

exist?メソッドは、引数として正規表現などのパターンを受け取り、現在のスキャン位置からそのパターンがマッチするかどうかを確認します。パターンが見つかった場合はtrueを、見つからなかった場合はfalseを返します。このメソッドの重要な特徴は、パターンの有無を確認するだけで、StringScannerオブジェクトの内部的なスキャン位置は移動しない点です。そのため、次にscanメソッドなどで実際に文字列を読み進める前に、特定のパターンが存在するかどうかを事前に調べたい場合に利用できます。

システムエンジニアを目指す初心者の方にとって、例えばログファイルや設定ファイルなど、大量のテキストデータから特定のキーワードやデータの有無を効率的に判定したい場合に役立つ機能です。しかし、Ruby 2.0以降ではexist?メソッドは非推奨（deprecated）とされており、代替としてmatch?メソッドの利用が推奨されています。新しいコードを記述する際には、将来的な互換性を考慮してmatch?メソッドを使用することが望ましいです。

Copy
1require 'strscan'
2
3scanner = StringScanner.new('This is a Ruby string.')
4# スキャン対象文字列に正規表現 '/Ruby/' にマッチする部分が存在するかを確認します。
5found = scanner.exist?(/Ruby/)
6# found は true となります。

pattern

• pattern: 検索する文字列または正規表現

String | nil

指定された文字列が、スキャナーの現在の位置からパターンに一致するかどうかを調べます。一致した場合は、一致した部分文字列を返します。一致しない場合は nil を返します。