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

【Ruby3.x】Regexp::timeout=()メソッドの使い方

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

作成日: 更新日:

基本的な使い方

timeout=メソッドは、正規表現のマッチング処理にタイムアウト時間を設定するメソッドです。

RubyのRegexpクラスは、文字列の中から特定のパターンを見つけ出すための正規表現を扱うためのクラスです。正規表現は非常に強力な機能ですが、複雑なパターンや特定の入力データによっては、マッチングの処理に予想以上の時間がかかってしまい、その結果としてプログラム全体の応答が遅延したり、最悪の場合フリーズしたりする危険性があります。

このtimeout=メソッドは、このような問題を防ぐために用意されています。正規表現のマッチング処理に対して、完了するまでの最大許容時間を秒単位で設定することができます。例えば、5秒と設定した場合、その正規表現によるマッチング処理が5秒を超えても完了しない場合、Regexp::TimeoutErrorという専用のエラー(例外)を発生させ、処理を強制的に中断します。

これにより、アプリケーションが予期せぬ長時間にわたってブロックされることを回避し、常に安定したパフォーマンスを維持できるようになります。引数には、タイムアウトさせたい秒数を数値で指定し、nilを設定することでタイムアウト機能を無効にすることも可能です。セキュリティや安定性が求められるシステムにおいて、正規表現を安全に利用するために非常に重要な機能です。

構文(syntax)

1r = /pattern/
2r.timeout = 1.0

引数(parameters)

sec

  • sec: 正規表現のマッチング操作がタイムアウトするまでの秒数を指定する数値

戻り値(return)

Integer または nil

指定された正規表現オブジェクトのタイムアウト値を設定し、その設定されたタイムアウト値を返します。タイムアウト値が設定されていない場合はnilを返します。

関連コンテンツ