class Prism::Result - Documentation for Ruby 4.1
Description: class Prism::Result: This represents the result of a call to Prism. parse or Prism.
Keywords: ruby,class,Prism::Result

🔍

No recent searches

# class Prism::Result

This represents the result of a call to `Prism.parse` or `Prism.parse_file`. It contains the requested structure, any comments that were encounters, and any errors that were encountered.

### Attributes

comments [R]

The list of comments that were encountered during parsing.

data_loc [R]

An optional location that represents the location of the END marker and the rest of the content of the file. This content is loaded into the DATA constant when the file being parsed is the main file being executed.

errors [R]

The list of errors that were generated during parsing.

magic_comments [R]

The list of magic comments that were encountered during parsing.

source [R]

A `Source` instance that represents the source code that was parsed.

warnings [R]

The list of warnings that were generated during parsing.

### Public Class Methods

new (comments, magic_comments, data_loc, errors, warnings, continuable, source)
Source

    # File lib/prism/parse_result.rb, line 927
    def initialize(comments, magic_comments, data_loc, errors, warnings, continuable, source)
      @comments = comments
      @magic_comments = magic_comments
      @data_loc = data_loc
      @errors = errors
      @warnings = warnings
      @continuable = continuable
      @source = source
    end

Create a new result object with the given values.

### Public Instance Methods

code_units_cache (encoding)
Source

    # File lib/prism/parse_result.rb, line 996
    def code_units_cache(encoding)
      source.code_units_cache(encoding)
    end

Create a code units cache for the given encoding.

continuable? ()
Source

    # File lib/prism/parse_result.rb, line 989
    def continuable?
      @continuable
    end

Returns true if the parsed source is an incomplete expression that could become valid with additional input. This is useful for REPL contexts (such as IRB) where the user may be entering a multi-line expression one line at a time and the implementation needs to determine whether to wait for more input or to evaluate what has been entered so far.

Concretely, this returns true when every error present is caused by the parser reaching the end of the input before a construct was closed (e.g. an unclosed string, array, block, or keyword), and returns false when any error is caused by a token that makes the input structurally invalid regardless of what might follow (e.g. a stray `end`, `]`, or `)` with no matching opener).

Examples:

    Prism.parse("1 + [").continuable?      #=> true  (unclosed array)
    Prism.parse("1 + ]").continuable?      #=> false (stray ])
    Prism.parse("tap do").continuable?     #=> true  (unclosed block)
    Prism.parse("end.tap do").continuable? #=> false (stray end)

encoding ()
Source

    # File lib/prism/parse_result.rb, line 947
    def encoding
      source.encoding
    end

Returns the encoding of the source code that was parsed.

failure? ()
Source

    # File lib/prism/parse_result.rb, line 963
    def failure?
      !success?
    end

Returns true if there were errors during parsing and false if there were not.

success? ()
Source

    # File lib/prism/parse_result.rb, line 955
    def success?
      errors.empty?
    end

Returns true if there were no errors during parsing and false if there were.