Prism::StringNode

Class

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

flags

Read

protected attr_reader flags: Integer

unescaped

Read

attr_reader unescaped: String

Class Methods

new(source, flags, opening_loc, content_loc, closing_loc, unescaped, location)
::

def initialize: (Integer flags, Location? opening_loc, Location content_loc, Location? closing_loc, String unescaped, Location location) -> void

type
::

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

Instance Methods

===(other)
#

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

accept(visitor)
#

def accept: (Visitor visitor) -> void

child_nodes
#

def child_nodes: () -> Array[nil | Node]

closing
#

def closing: () -> String?

closing_loc
#

attr_reader closing_loc: Location?

comment_targets
#

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

compact_child_nodes
#

def compact_child_nodes: () -> Array

content
#

def content: () -> String

content_loc
#

attr_reader content_loc: Location

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

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

deconstruct
#
An alias for child_nodes

deconstruct_keys(keys)
#

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

forced_binary_encoding?
#

def forced_binary_encoding?: () -> bool

forced_utf8_encoding?
#

def forced_utf8_encoding?: () -> bool

frozen?
#

def frozen?: () -> bool

inspect
#

def inspect -> String

mutable?
#

def mutable?: () -> bool

opening
#

def opening: () -> String?

opening_loc
#

attr_reader opening_loc: Location?

to_interpolated
#

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
#

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol