class Prism::Result - Documentation for Ruby 4.0
Description: class Prism::Result: parse_file. It contains the requested structure, any comments that were encounters, and any errors that were encountered.
Keywords: ruby,class,Prism::Result

🔍

No recent searches

# class Prism::Result

This represents the result of a call to ::parse or ::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, source)
Source

    # File lib/prism/parse_result.rb, line 689
    def initialize(comments, magic_comments, data_loc, errors, warnings, source)
      @comments = comments
      @magic_comments = magic_comments
      @data_loc = data_loc
      @errors = errors
      @warnings = warnings
      @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 721
    def code_units_cache(encoding)
      source.code_units_cache(encoding)
    end

Create a code units cache for the given encoding.

deconstruct_keys (keys)
Source

    # File lib/prism/parse_result.rb, line 699
    def deconstruct_keys(keys)
      { comments: comments, magic_comments: magic_comments, data_loc: data_loc, errors: errors, warnings: warnings }
    end

Implement the hash pattern matching interface for `Result`.

encoding ()
Source

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

Returns the encoding of the source code that was parsed.

failure? ()
Source

    # File lib/prism/parse_result.rb, line 716
    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 710
    def success?
      errors.empty?
    end

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