class Prism::BlockLocalVariableNode

Represents a block local variable.

a { |; b| }



protected attr_reader flags: Integer


attr_reader name: Symbol

Public Class Methods

new(source, flags, name, location) click to toggle source

def initialize: (Integer flags, Symbol name, Location location) -> void

# File prism/node.rb, line 1646
def initialize(source, flags, name, location)
  @source = source
  @location = location
  @flags = flags
  @name = name
type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File prism/node.rb, line 1727
def self.type

Public Instance Methods

===(other) click to toggle source

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

# File prism/node.rb, line 1733
def ===(other)
  other.is_a?(BlockLocalVariableNode) &&
    (flags === other.flags) &&
    (name ===
accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 1654
def accept(visitor)
child_nodes() click to toggle source

def child_nodes: () -> Array[nil | Node]

# File prism/node.rb, line 1659
def child_nodes
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File prism/node.rb, line 1669
def comment_targets
  [] #: Array[Prism::node | Location]
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 1664
def compact_child_nodes
copy(flags: self.flags, name:, location: self.location) click to toggle source

def copy: (?flags: Integer, ?name: Symbol, ?location: Location) -> BlockLocalVariableNode

# File prism/node.rb, line 1674
def copy(flags: self.flags, name:, location: self.location), flags, name, location)

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { flags: Integer, name: Symbol, location: Location }

# File prism/node.rb, line 1682
def deconstruct_keys(keys)
  { flags: flags, name: name, location: location }
inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 1699
def inspect
repeated_parameter?() click to toggle source

def repeated_parameter?: () -> bool

# File prism/node.rb, line 1694
def repeated_parameter?
type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

# File prism/node.rb, line 1717
def type