class Prism::BlockArgumentNode - Documentation for Ruby 4.1
Description: class Prism::BlockArgumentNode: Represents a block argument using `&`.
Keywords: ruby,class,Prism::BlockArgumentNode

🔍

No recent searches

# class Prism::BlockArgumentNode

Represents a block argument using `&`.

    bar(&args)
        ^^^^^

### Public Class Methods

new (source, node_id, location, flags, expression, operator_loc)
Source

    # File lib/prism/node.rb, line 2660
    def initialize(source, node_id, location, flags, expression, operator_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @expression = expression
      @operator_loc = operator_loc
    end

Initialize a new `BlockArgumentNode` node.

### Public Instance Methods

expression → Node | nil
Source

    # File lib/prism/node.rb, line 2767
    def expression
      @expression
    end

The expression that is being passed as a block argument. This can be any non-void expression.

    foo(&args)
         ^^^^

## Locations

### Public Instance Methods

operator_loc → Location
Source

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

Represents the `Location` of the `&` operator.

    foo(&args)
        ^

## 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 2747
    def self.type
      :block_argument_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 2690
    def child_nodes
      [expression]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 2716
    def comment_targets
      [*expression, operator_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → BlockArgumentNode
Source

    # File lib/prism/node.rb, line 2726
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, expression: self.expression, operator_loc: self.operator_loc)
      BlockArgumentNode.new(source, node_id, location, flags, expression, operator_loc)
    end

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

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

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

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

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 2740
    def type
      :block_argument_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 2792
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc)
    end

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

## Slicing

### Public Instance Methods

operator → String
Source

    # File lib/prism/node.rb, line 2804
    def operator
      operator_loc.slice
    end

Slice the location of `operator_loc` from the source.