class Prism::MatchWriteNode

Represents writing local variables using a regular expression match with named capture groups.

/(?<foo>bar)/ =~ baz
^^^^^^^^^^^^^^^^^^^^

Attributes

call[R]

attr_reader call: CallNode

targets[R]

attr_reader targets: Array

Public Class Methods

new(source, call, targets, location) click to toggle source

def initialize: (CallNode call, Array targets, Location location) -> void

# File lib/prism/node.rb, line 12807
def initialize(source, call, targets, location)
  @source = source
  @newline = false
  @location = location
  @call = call
  @targets = targets
end
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 lib/prism/node.rb, line 12888
def self.type
  :match_write_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 12816
def accept(visitor)
  visitor.visit_match_write_node(self)
end
child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 12821
def child_nodes
  [call, *targets]
end
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 12831
def comment_targets
  [call, *targets] #: Array[Prism::node | Location]
end
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 12826
def compact_child_nodes
  [call, *targets]
end
copy(call: self.call, targets: self.targets, location: self.location) click to toggle source

def copy: (?call: CallNode, ?targets: Array, ?location: Location) -> MatchWriteNode

# File lib/prism/node.rb, line 12836
def copy(call: self.call, targets: self.targets, location: self.location)
  MatchWriteNode.new(source, call, targets, location)
end
deconstruct()

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

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

def deconstruct_keys: (Array keys) -> { call: CallNode, targets: Array, location: Location }

# File lib/prism/node.rb, line 12844
def deconstruct_keys(keys)
  { call: call, targets: targets, location: location }
end
inspect(inspector = NodeInspector.new) click to toggle source

def inspect(NodeInspector inspector) -> String

# File lib/prism/node.rb, line 12856
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── call:\n"
  inspector << inspector.child_node(call, "│   ")
  inspector << "└── targets: #{inspector.list("#{inspector.prefix}    ", targets)}"
  inspector.to_str
end
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 lib/prism/node.rb, line 12878
def type
  :match_write_node
end