🔍

No recent searches

# 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)
Source

    # File lib/prism/node.rb, line 19623
    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

Initialize a new `YieldNode` node.

type ()
Source

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

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 19762
    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

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 19635
    def accept(visitor)
      visitor.visit_yield_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

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)
Source

    # File lib/prism/node.rb, line 19664
    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

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

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 19672
    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

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

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

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

      yield arguments if arguments
    end

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

inspect ()
Source

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

def inspect -> `String`

keyword ()
Source

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

def keyword: () -> `String`

keyword_loc ()
Source

    # File lib/prism/node.rb, line 19677
    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`

lparen ()
Source

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

def lparen: () -> `String`?

lparen_loc ()
Source

    # File lib/prism/node.rb, line 19690
    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

attr_reader `lparen_loc`: `Location`?

rparen ()
Source

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

def rparen: () -> `String`?

rparen_loc ()
Source

    # File lib/prism/node.rb, line 19712
    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

attr_reader `rparen_loc`: `Location`?

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 19685
    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_lparen_loc (repository)
Source

    # File lib/prism/node.rb, line 19704
    def save_lparen_loc(repository)
      repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
    end

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

save_rparen_loc (repository)
Source

    # File lib/prism/node.rb, line 19726
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
    end

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

type ()
Source

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

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