class Prism::RescueNode - Documentation for Ruby 4.0
Description: class Prism::RescueNode: Represents a rescue statement. begin rescue Foo, *splat, Bar => ex foo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ end `Foo, *splat, Bar` are in
Keywords: ruby,class,Prism::RescueNode

🔍

No recent searches

# class Prism::RescueNode

Represents a rescue statement.

    begin
    rescue Foo, *splat, Bar => ex
      foo
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    end

`Foo, *splat, Bar` are in the `exceptions` field. `ex` is in the `reference` field.

### Attributes

exceptions [R]

attr_reader exceptions: Array

reference [R]

attr_reader reference: `LocalVariableTargetNode` | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `MissingNode` | nil

statements [R]

attr_reader statements: `StatementsNode`?

subsequent [R]

attr_reader subsequent: `RescueNode`?

### Public Class Methods

new (source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent)
Source

    # File lib/prism/node.rb, line 16868
    def initialize(source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @keyword_loc = keyword_loc
      @exceptions = exceptions
      @operator_loc = operator_loc
      @reference = reference
      @then_keyword_loc = then_keyword_loc
      @statements = statements
      @subsequent = subsequent
    end

Initialize a new `RescueNode` node.

type ()
Source

    # File lib/prism/node.rb, line 17019
    def self.type
      :rescue_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 17025
    def ===(other)
      other.is_a?(RescueNode) &&
        (keyword_loc.nil? == other.keyword_loc.nil?) &&
        (exceptions.length == other.exceptions.length) &&
        exceptions.zip(other.exceptions).all? { |left, right| left === right } &&
        (operator_loc.nil? == other.operator_loc.nil?) &&
        (reference === other.reference) &&
        (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
        (statements === other.statements) &&
        (subsequent === other.subsequent)
    end

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

accept (visitor)
Source

    # File lib/prism/node.rb, line 16883
    def accept(visitor)
      visitor.visit_rescue_node(self)
    end

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

    # File lib/prism/node.rb, line 16888
    def child_nodes
      [*exceptions, reference, statements, subsequent]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 16913
    def comment_targets
      [keyword_loc, *exceptions, *operator_loc, *reference, *then_keyword_loc, *statements, *subsequent] #: Array[Prism::node | Location]
    end

def `comment_targets`: () -> Array[Node | Location]

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 16903
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact.concat(exceptions)
      compact << reference if reference
      compact << statements if statements
      compact << subsequent if subsequent
      compact
    end

def `compact_child_nodes`: () -> Array

consequent ()
Source

    # File lib/prism/node_ext.rb, line 497
    def consequent
      deprecated("subsequent")
      subsequent
    end

Returns the subsequent rescue clause of the rescue node. This method is deprecated in favor of `subsequent`.

copy (node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, exceptions: self.exceptions, operator_loc: self.operator_loc, reference: self.reference, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent)
Source

    # File lib/prism/node.rb, line 16918
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, exceptions: self.exceptions, operator_loc: self.operator_loc, reference: self.reference, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent)
      RescueNode.new(source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?keyword_loc: `Location`, ?exceptions: Array, ?operator_loc: `Location`?, ?reference: `LocalVariableTargetNode` | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `MissingNode` | nil, ?then_keyword_loc: `Location`?, ?statements: `StatementsNode`?, ?subsequent: `RescueNode`?) -> `RescueNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 16926
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, keyword_loc: keyword_loc, exceptions: exceptions, operator_loc: operator_loc, reference: reference, then_keyword_loc: then_keyword_loc, statements: statements, subsequent: subsequent }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, `keyword_loc`: `Location`, exceptions: Array, `operator_loc`: `Location`?, reference: `LocalVariableTargetNode` | `InstanceVariableTargetNode` | `ClassVariableTargetNode` | `GlobalVariableTargetNode` | `ConstantTargetNode` | `ConstantPathTargetNode` | `CallTargetNode` | `IndexTargetNode` | `BackReferenceReadNode` | `NumberedReferenceReadNode` | `MissingNode` | nil, `then_keyword_loc`: `Location`?, statements: `StatementsNode`?, subsequent: `RescueNode`? }

each_child_node () { |node| ... }
Source

    # File lib/prism/node.rb, line 16893
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      exceptions.each { |node| yield node }
      yield reference if reference
      yield statements if statements
      yield subsequent if subsequent
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

    # File lib/prism/node.rb, line 17009
    def inspect
      InspectVisitor.compose(self)
    end

def inspect -> `String`

keyword ()
Source

    # File lib/prism/node.rb, line 16994
    def keyword
      keyword_loc.slice
    end

def keyword: () -> `String`

keyword_loc ()
Source

    # File lib/prism/node.rb, line 16931
    def keyword_loc
      location = @keyword_loc
      return location if location.is_a?(Location)
      @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `keyword_loc`: `Location`

operator ()
Source

    # File lib/prism/node.rb, line 16999
    def operator
      operator_loc&.slice
    end

def operator: () -> `String`?

operator_loc ()
Source

    # File lib/prism/node.rb, line 16947
    def operator_loc
      location = @operator_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

attr_reader `operator_loc`: `Location`?

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 16939
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

Save the `keyword_loc` location using the given saved source so that it can be retrieved later.

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 16961
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
    end

Save the `operator_loc` location using the given saved source so that it can be retrieved later.

save_then_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 16983
    def save_then_keyword_loc(repository)
      repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
    end

Save the `then_keyword_loc` location using the given saved source so that it can be retrieved later.

then_keyword ()
Source

    # File lib/prism/node.rb, line 17004
    def then_keyword
      then_keyword_loc&.slice
    end

def `then_keyword`: () -> `String`?

then_keyword_loc ()
Source

    # File lib/prism/node.rb, line 16969
    def then_keyword_loc
      location = @then_keyword_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @then_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

attr_reader `then_keyword_loc`: `Location`?

type ()
Source

    # File lib/prism/node.rb, line 17014
    def type
      :rescue_node
    end

Return a symbol representation of this node type. See `Node#type`.