class Prism::SourceEncodingNode

Represents the use of the ‘__ENCODING__` keyword.

__ENCODING__
^^^^^^^^^^^^

Public Class Methods

new(source, location) click to toggle source

def initialize: (Location location) -> void

# File lib/prism/node.rb, line 17063
def initialize(source, location)
  @source = source
  @location = location
end
type() click to toggle source

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 lib/prism/node.rb, line 17130
def self.type
  :source_encoding_node
end

Public Instance Methods

===(other) click to toggle source

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

# File lib/prism/node.rb, line 17136
def ===(other)
  other.is_a?(SourceEncodingNode)
end
accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 17069
def accept(visitor)
  visitor.visit_source_encoding_node(self)
end
child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 17074
def child_nodes
  []
end
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 17084
def comment_targets
  [] #: Array[Prism::node | Location]
end
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 17079
def compact_child_nodes
  []
end
copy(location: self.location) click to toggle source

def copy: (?location: Location) -> SourceEncodingNode

# File lib/prism/node.rb, line 17089
def copy(location: self.location)
  SourceEncodingNode.new(source, location)
end
deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { location: Location }

# File lib/prism/node.rb, line 17097
def deconstruct_keys(keys)
  { location: location }
end
inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 17102
def inspect
  InspectVisitor.compose(self)
end
type() click to toggle source

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 lib/prism/node.rb, line 17120
def type
  :source_encoding_node
end