class Prism::XStringNode - Documentation for Ruby 4.1
Description: class Prism::XStringNode: Represents an xstring literal with no interpolation.
Keywords: ruby,class,Prism::XStringNode

🔍

No recent searches

# class Prism::XStringNode

Represents an xstring literal with no interpolation.

    `foo`
    ^^^^^

### Public Class Methods

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

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

### Public Instance Methods

heredoc? ()
Source

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

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

to_interpolated ()
Source

    # File lib/prism/node_ext.rb, line 148
    def to_interpolated
      InterpolatedXStringNode.new(
        source,
        -1,
        location,
        flags,
        opening_loc,
        [StringNode.new(source, node_id, content_loc, 0, nil, content_loc, nil, unescaped)],
        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.

unescaped → String
Source

    # File lib/prism/node.rb, line 31314
    def unescaped
      @unescaped
    end

Returns the `unescaped` attribute.

## Flags

### Public Instance Methods

forced_binary_encoding? ()
Source

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

internal bytes forced the encoding to binary

forced_utf8_encoding? ()
Source

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

internal bytes forced the encoding to UTF-8

## Locations

### Public Instance Methods

closing_loc → Location
Source

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

Returns the `Location` represented by `closing_loc`.

content_loc → Location
Source

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

Returns the `Location` represented by `content_loc`.

opening_loc → Location
Source

    # File lib/prism/node.rb, line 31249
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    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 31215
    def self.type
      :x_string_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → XStringNode
Source

    # File lib/prism/node.rb, line 31194
    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)
      XStringNode.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
    end

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

deconstruct ()
Alias for: child_nodes
each_child_node (&blk)
Source

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

    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 31208
    def type
      :x_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 31304
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    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 31282
    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 31260
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

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

## Slicing

### Public Instance Methods

closing → String
Source

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

Slice the location of `closing_loc` from the source.

content → String
Source

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

Slice the location of `content_loc` from the source.

opening → String
Source

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

Slice the location of `opening_loc` from the source.