class Prism::InterpolatedStringNode - Documentation for Ruby 4.1
Description: class Prism::InterpolatedStringNode: Represents a string literal that contains interpolation.
Keywords: ruby,class,Prism::InterpolatedStringNode

🔍

No recent searches

# class Prism::InterpolatedStringNode

Represents a string literal that contains interpolation.

    "foo #{bar} baz"
    ^^^^^^^^^^^^^^^^

### Public Class Methods

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

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

Initialize a new `InterpolatedStringNode` node.

### Public Instance Methods

heredoc? ()
Source

    # File lib/prism/node_ext.rb, line 97
    def heredoc?
      HeredocQuery.heredoc?(opening)
    end

Returns true if this node was represented as a heredoc in the source code.

parts → Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode | InterpolatedStringNode]
Source

    # File lib/prism/node.rb, line 18645
    def parts
      @parts
    end

Returns the `parts` attribute.

## Flags

### Public Instance Methods

frozen? ()
Source

    # File lib/prism/node.rb, line 18600
    def frozen?
      flags.anybits?(InterpolatedStringNodeFlags::FROZEN)
    end

frozen by virtue of a `frozen_string_literal: true` comment or `--enable-frozen-string-literal`; only for adjacent string literals like `'a' 'b'`

mutable? ()
Source

    # File lib/prism/node.rb, line 18608
    def mutable?
      flags.anybits?(InterpolatedStringNodeFlags::MUTABLE)
    end

mutable by virtue of a `frozen_string_literal: false` comment or `--disable-frozen-string-literal`; only for adjacent string literals like `'a' 'b'`

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

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

Returns the `Location` represented by `closing_loc`.

opening_loc → Location | nil
Source

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

Returns the `Location` represented by `opening_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 18585
    def self.type
      :interpolated_string_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → InterpolatedStringNode
Source

    # File lib/prism/node.rb, line 18564
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, parts: self.parts, closing_loc: self.closing_loc)
      InterpolatedStringNode.new(source, node_id, location, flags, opening_loc, parts, 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 18538
    def each_child_node(&blk)
      return to_enum(:each_child_node) unless block_given?

      parts.each { |node| yield node }
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 18578
    def type
      :interpolated_string_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 18673
    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 18636
    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 18694
    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 18684
    def opening
      opening_loc&.slice
    end

Slice the location of `opening_loc` from the source.