class Prism::YieldNode - Documentation for Ruby 4.1
Description: class Prism::YieldNode: Represents the use of the `yield` keyword.
Keywords: ruby,class,Prism::YieldNode

🔍

No recent searches

# class Prism::YieldNode

Represents the use of the `yield` keyword.

    yield 1
    ^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, keyword_loc, lparen_loc, arguments, rparen_loc)
Source

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

### Public Instance Methods

arguments → ArgumentsNode | nil
Source

    # File lib/prism/node.rb, line 31531
    def arguments
      @arguments
    end

Returns the `arguments` attribute.

## Locations

### Public Instance Methods

keyword_loc → Location
Source

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

Returns the `Location` represented by `keyword_loc`.

lparen_loc → Location | nil
Source

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

Returns the `Location` represented by `lparen_loc`.

rparen_loc → Location | nil
Source

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

Returns the `Location` represented by `rparen_loc`.

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

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

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 31425
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      if (arguments = self.arguments); compact << arguments; end
      compact
    end

See `Node.compact_child_nodes`.

copy(**fields) → YieldNode
Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |arguments| ... }
Source

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

      if (arguments = self.arguments); yield arguments; end
    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_keyword_loc (repository)
Source

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

## Slicing

### Public Instance Methods

keyword → String
Source

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

Slice the location of `keyword_loc` from the source.

lparen → String | nil
Source

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

Slice the location of `lparen_loc` from the source.

rparen → String | nil
Source

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

Slice the location of `rparen_loc` from the source.