class Prism::SymbolNode
Represents a symbol literal or a symbol contained within a ‘%i` list.
:foo ^^^^ %i[foo] ^^^
Attributes
attr_reader closing_loc
: Location
?
attr_reader opening_loc
: Location
?
attr_reader unescaped: String
Public Class Methods
def initialize: (flags: Integer, opening_loc
: Location
?, value_loc
: Location
?, closing_loc
: Location
?, unescaped: String, location: Location
) -> void
# File prism/node.rb, line 16167 def initialize(flags, opening_loc, value_loc, closing_loc, unescaped, location) @flags = flags @opening_loc = opening_loc @value_loc = value_loc @closing_loc = closing_loc @unescaped = unescaped @location = location end
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
# File prism/node.rb, line 16282 def self.type :symbol_node end
Public Instance Methods
def accept: (visitor: Visitor
) -> void
# File prism/node.rb, line 16177 def accept(visitor) visitor.visit_symbol_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File prism/node.rb, line 16182 def child_nodes [] end
def closing: () -> String?
# File prism/node.rb, line 16242 def closing closing_loc&.slice end
def comment_targets
: () -> Array[Node | Location]
# File prism/node.rb, line 16192 def comment_targets [*opening_loc, *value_loc, *closing_loc] end
def compact_child_nodes
: () -> Array
# File prism/node.rb, line 16187 def compact_child_nodes [] end
def copy: (**params) -> SymbolNode
# File prism/node.rb, line 16197 def copy(**params) SymbolNode.new( params.fetch(:flags) { flags }, params.fetch(:opening_loc) { opening_loc }, params.fetch(:value_loc) { value_loc }, params.fetch(:closing_loc) { closing_loc }, params.fetch(:unescaped) { unescaped }, params.fetch(:location) { location }, ) end
def deconstruct_keys
: (keys: Array) -> Hash[Symbol, nil | Node
| Array | String | Token
| Array | Location]
# File prism/node.rb, line 16212 def deconstruct_keys(keys) { flags: flags, opening_loc: opening_loc, value_loc: value_loc, closing_loc: closing_loc, unescaped: unescaped, location: location } end
def forced_binary_encoding?: () -> bool
# File prism/node.rb, line 16222 def forced_binary_encoding? flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING) end
def forced_us_ascii_encoding?: () -> bool
# File prism/node.rb, line 16227 def forced_us_ascii_encoding? flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING) end
def forced_utf8_encoding?: () -> bool
# File prism/node.rb, line 16217 def forced_utf8_encoding? flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING) end
def inspect(inspector: NodeInspector) -> String
# File prism/node.rb, line 16247 def inspect(inspector = NodeInspector.new) inspector << inspector.header(self) flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n" inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n" inspector << "├── value_loc: #{inspector.location(value_loc)}\n" inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n" inspector << "└── unescaped: #{unescaped.inspect}\n" inspector.to_str end
def opening: () -> String?
# File prism/node.rb, line 16232 def opening opening_loc&.slice end
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
# File prism/node.rb, line 16272 def type :symbol_node end
def value: () -> String?
# File prism/node.rb, line 16237 def value value_loc&.slice end