class Prism::Result (Ruby 4.1 リファレンスマニュアル)

要約

Prism?.parse・Prism?.lex・Prism?.parse_lex などの解析系メソッドの戻り値(Prism::ParseResult・Prism::LexResult・ Prism::ParseLexResult)の共通基底クラスです。解析結果本体 (value)以外の付随情報(コメント・マジックコメント・エラー・警告・ソースコード)を保持します。

Ruby 3.3 の prism にはこのクラスはなく、Prism::ParseResult がこれらのメソッドを直接持っていました。

[SEE_ALSO] Prism::ParseResult, Prism::LexResult, Prism::ParseLexResult

インスタンスメソッド

code_units_cache(encoding) -> ProcRuby 3.4 から[permalink][rdoc][edit]

バイトオフセットを指定エンコーディングのコード単位のオフセットへ変換する処理をキャッシュ付きで行う Proc を返します。 Prism::Location の code_units 系メソッドを多数の位置に対して繰り返し使う場合の高速化用です。

[PARAM] encoding:: コード単位の基準となるエンコーディング

comments -> ArrayRuby 3.4 から[permalink][rdoc][edit]

解析中に見つかったコメント(Prism::Comment のサブクラスのインスタンス)の配列を返します。

[SEE_ALSO] Prism::ParseResult#comments

continuable? -> boolRuby 4.1 から[permalink][rdoc][edit]

解析したソースコードが、追加の入力によって正しい構文になりうる不完全な式であった場合に true を返します。

IRB のような REPL で、ユーザーが複数行にわたる式を 1 行ずつ入力している途中に、追加の入力を待つべきか、それまでに入力された内容を評価すべきかを判断するために使うことを想定しています。具体的には、発生したすべてのエラーが文字列・配列・ブロックなどが閉じられないまま入力が終了したことによるものであれば true を、end や ]、) が対応する開始位置なしに単独で現れるなど、後続の入力によらず構文として不正であることが確定しているエラーが 1 つでもあれば false を返します。

[SEE_ALSO] Prism::Result#success?, Prism::Result#failure?

data_loc -> Prism::Location | nilRuby 3.4 から[permalink][rdoc][edit]