class Prism::ArrayNode - Documentation for Ruby 4.1
Description: class Prism::ArrayNode: Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.
Keywords: ruby,class,Prism::ArrayNode

🔍

No recent searches

# class Prism::ArrayNode

Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.

    [1, 2, 3]
    ^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, elements, opening_loc, closing_loc)
Source

    # File lib/prism/node.rb, line 1375
    def initialize(source, node_id, location, flags, elements, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @elements = elements
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

Initialize a new `ArrayNode` node.

### Public Instance Methods

elements → Array[Node]
Source

    # File lib/prism/node.rb, line 1486
    def elements
      @elements
    end

Represent the list of zero or more non-void expressions within the array.

## Flags

### Public Instance Methods

contains_splat? ()
Source

    # File lib/prism/node.rb, line 1476
    def contains_splat?
      flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
    end

if array contains splat nodes

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

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

Represents the optional source `Location` for the closing token.

    [1,2,3]                 # "]"
    %w[foo bar baz]         # "]"
    %I(apple orange banana) # ")"
    foo = 1, 2, 3           # nil

opening_loc → Location | nil
Source

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

Represents the optional source `Location` for the opening token.

    [1,2,3]                 # "["
    %w[foo bar baz]         # "%w["
    %I(apple orange banana) # "%I("
    foo = 1, 2, 3           # nil

## 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 1461
    def self.type
      :array_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 1406
    def child_nodes
      [*elements]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 1430
    def comment_targets
      [*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 1423
    def compact_child_nodes
      [*elements]
    end

See `Node.compact_child_nodes`.

copy(**fields) → ArrayNode
Source

    # File lib/prism/node.rb, line 1440
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      ArrayNode.new(source, node_id, location, flags, elements, opening_loc, closing_loc)
    end

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

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

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

      elements.each { |node| yield node }
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 1454
    def type
      :array_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 1551
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

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

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 1519
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

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

## Slicing

### Public Instance Methods

closing → String | nil
Source

    # File lib/prism/node.rb, line 1572
    def closing
      closing_loc&.slice
    end

Slice the location of `closing_loc` from the source.

opening → String | nil
Source

    # File lib/prism/node.rb, line 1562
    def opening
      opening_loc&.slice
    end

Slice the location of `opening_loc` from the source.