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] Array[comment]

The list of comments that were encountered during parsing.

data_loc [R] Location?

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] Array[ParseError]

The list of errors that were generated during parsing.

magic_comments [R] Array[MagicComment]

The list of magic comments that were encountered during parsing.

source [R] Source

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

warnings [R] Array[ParseWarning]

The list of warnings that were generated during parsing.

Public Class Methods

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

(Array[comment] comments, Array[MagicComment] magic_comments, Location? data_loc, Array[ParseError] errors, Array[ParseWarning] warnings, Source source) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 698
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)

(Encoding encoding) → _CodeUnitsCache

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 730
def code_units_cache(encoding)
  source.code_units_cache(encoding)
end

Create a code units cache for the given encoding.

deconstruct_keys (keys)

(Array[Symbol]? keys) → Hash[Symbol, untyped]

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 708
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 ()

() → Encoding

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 713
def encoding
  source.encoding
end

Returns the encoding of the source code that was parsed.

failure? ()

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 725
def failure?
  !success?
end

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

success? ()

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/prism-1.9.0/lib/prism/parse_result.rb, line 719
def success?
  errors.empty?
end

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