class Prism::StringNode - Documentation for Ruby 3.4
Description: class Prism::StringNode: Represents a string literal, a string contained within a `%w` list, or plain string content within an interpolated string.
Keywords: ruby,class,Prism::StringNode

# class Prism::StringNode

Represents a string literal, a string contained within a `%w` list, or plain string content within an interpolated string.

    "foo"
    ^^^^^

    %w[foo]
       ^^^

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

### Attributes

unescaped [R]

attr_reader unescaped: `String`

### Public Class Methods

new (source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
Source

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

Initialize a new `StringNode` node.

type ()
Source

    # File lib/prism/node.rb, line 17193
    def self.type
      :string_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 17199
    def ===(other)
      other.is_a?(StringNode) &&
        (flags === other.flags) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (content_loc.nil? == other.content_loc.nil?) &&
        (closing_loc.nil? == other.closing_loc.nil?) &&
        (unescaped === other.unescaped)
    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 17061
    def accept(visitor)
      visitor.visit_string_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`?

closing_loc ()
Source

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

attr_reader `closing_loc`: `Location`?

comment_targets ()
Source

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

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 17071
    def compact_child_nodes
      []
    end

def `compact_child_nodes`: () -> Array

content ()
Source

    # File lib/prism/node.rb, line 17173
    def content
      content_loc.slice
    end

def content: () -> `String`

content_loc ()
Source

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

attr_reader `content_loc`: `Location`

copy (node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
Source

    # File lib/prism/node.rb, line 17081
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
      StringNode.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?opening_loc: `Location`?, ?content_loc: `Location`, ?closing_loc: `Location`?, ?unescaped: `String`) -> `StringNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 17089
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, `opening_loc`: `Location`?, `content_loc`: `Location`, `closing_loc`: `Location`?, unescaped: `String` }

forced_binary_encoding? ()
Source

    # File lib/prism/node.rb, line 17099
    def forced_binary_encoding?
      flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
    end

def forced_binary_encoding?: () -> bool

forced_utf8_encoding? ()
Source

    # File lib/prism/node.rb, line 17094
    def forced_utf8_encoding?
      flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
    end

def forced_utf8_encoding?: () -> bool

frozen? ()
Source

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

def frozen?: () -> bool

inspect ()
Source

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

def inspect -> `String`

mutable? ()
Source

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

def mutable?: () -> bool

opening ()
Source

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

def opening: () -> `String`?

opening_loc ()
Source

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

attr_reader `opening_loc`: `Location`?

save_closing_loc (repository)
Source

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

    # File lib/prism/node.rb, line 17141
    def save_content_loc(repository)
      repository.enter(node_id, :content_loc)
    end

Save the `content_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 17128
    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.

to_interpolated ()
Source

    # File lib/prism/node_ext.rb, line 75
    def to_interpolated
      InterpolatedStringNode.new(
        source,
        -1,
        location,
        frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
        opening_loc,
        [copy(location: content_loc, opening_loc: nil, closing_loc: nil)],
        closing_loc
      )
    end

Occasionally it’s helpful to treat a string as if it were interpolated so that there’s a consistent interface for working with strings.

type ()
Source

    # File lib/prism/node.rb, line 17188
    def type
      :string_node
    end

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