class Prism::YieldNode

Represents the use of the ‘yield` keyword.

yield 1
^^^^^^^

Attributes

arguments[R]

attr_reader arguments: ArgumentsNode?

Public Class Methods

new(source, node_id, location, flags, keyword_loc, lparen_loc, arguments, rparen_loc) click to toggle source

Initialize a new YieldNode node.

# File lib/prism/node.rb, line 16244
def initialize(source, node_id, location, flags, keyword_loc, lparen_loc, arguments, rparen_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @lparen_loc = lparen_loc
  @arguments = arguments
  @rparen_loc = rparen_loc
end

type() click to toggle source

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

# File lib/prism/node.rb, line 16351
def self.type
  :yield_node
end

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 lib/prism/node.rb, line 16357
def ===(other)
  other.is_a?(YieldNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (arguments === other.arguments) &&
    (rparen_loc.nil? == other.rparen_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 16261
def child_nodes
  [arguments]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 16273
def comment_targets
  [keyword_loc, *lparen_loc, *arguments, *rparen_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 16266
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << arguments if arguments
  compact
end

copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, lparen_loc: self.lparen_loc, arguments: self.arguments, rparen_loc: self.rparen_loc) click to toggle source

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?lparen_loc: Location?, ?arguments: ArgumentsNode?, ?rparen_loc: Location?) -> YieldNode

# File lib/prism/node.rb, line 16278
def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, lparen_loc: self.lparen_loc, arguments: self.arguments, rparen_loc: self.rparen_loc)
  YieldNode.new(source, node_id, location, flags, keyword_loc, lparen_loc, arguments, rparen_loc)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, lparen_loc: Location?, arguments: ArgumentsNode?, rparen_loc: Location? }

# File lib/prism/node.rb, line 16286
def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, lparen_loc: lparen_loc, arguments: arguments, rparen_loc: rparen_loc }
end

inspect() click to toggle source

def inspect -> String

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

keyword() click to toggle source

def keyword: () -> String

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

keyword_loc() click to toggle source

attr_reader keyword_loc: Location

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

lparen() click to toggle source

def lparen: () -> String?

# File lib/prism/node.rb, line 16331
def lparen
  lparen_loc&.slice
end

lparen_loc() click to toggle source

attr_reader lparen_loc: Location?

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

rparen() click to toggle source

def rparen: () -> String?

# File lib/prism/node.rb, line 16336
def rparen
  rparen_loc&.slice
end

rparen_loc() click to toggle source

attr_reader rparen_loc: Location?

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

type() click to toggle source

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

# File lib/prism/node.rb, line 16346
def type
  :yield_node
end