class Prism::InNode - Documentation for Ruby 4.0
Description: class Prism::InNode: Represents the use of the `in` keyword in a case statement.
Keywords: ruby,class,Prism::InNode

🔍

No recent searches

# class Prism::InNode

Represents the use of the `in` keyword in a case statement.

    case a; in b then c end
            ^^^^^^^^^^^

### Attributes

pattern [R]

attr_reader pattern: Prism::node

statements [R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

new (source, node_id, location, flags, pattern, statements, in_loc, then_loc)
Source

    # File lib/prism/node.rb, line 9550
    def initialize(source, node_id, location, flags, pattern, statements, in_loc, then_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @pattern = pattern
      @statements = statements
      @in_loc = in_loc
      @then_loc = then_loc
    end

Initialize a new `InNode` node.

type ()
Source

    # File lib/prism/node.rb, line 9664
    def self.type
      :in_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 9670
    def ===(other)
      other.is_a?(InNode) &&
        (pattern === other.pattern) &&
        (statements === other.statements) &&
        (in_loc.nil? == other.in_loc.nil?) &&
        (then_loc.nil? == other.then_loc.nil?)
    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 9562
    def accept(visitor)
      visitor.visit_in_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 9567
    def child_nodes
      [pattern, statements]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 9588
    def comment_targets
      [pattern, *statements, in_loc, *then_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 9580
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << pattern
      compact << statements if statements
      compact
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, pattern: self.pattern, statements: self.statements, in_loc: self.in_loc, then_loc: self.then_loc)
Source

    # File lib/prism/node.rb, line 9593
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, pattern: self.pattern, statements: self.statements, in_loc: self.in_loc, then_loc: self.then_loc)
      InNode.new(source, node_id, location, flags, pattern, statements, in_loc, then_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?pattern: Prism::node, ?statements: `StatementsNode`?, ?in_loc: `Location`, ?then_loc: `Location`?) -> `InNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 9601
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, pattern: pattern, statements: statements, in_loc: in_loc, then_loc: then_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, pattern: Prism::node, statements: `StatementsNode`?, `in_loc`: `Location`, `then_loc`: `Location`? }

each_child_node () { |pattern| ... }
Source

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

      yield pattern
      yield statements if statements
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

in ()
Source

    # File lib/prism/node.rb, line 9644
    def in
      in_loc.slice
    end

def in: () -> `String`

in_loc ()
Source

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

attr_reader `in_loc`: `Location`

inspect ()
Source

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

def inspect -> `String`

save_in_loc (repository)
Source

    # File lib/prism/node.rb, line 9620
    def save_in_loc(repository)
      repository.enter(node_id, :in_loc)
    end

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

save_then_loc (repository)
Source

    # File lib/prism/node.rb, line 9639
    def save_then_loc(repository)
      repository.enter(node_id, :then_loc) unless @then_loc.nil?
    end

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

then ()
Source

    # File lib/prism/node.rb, line 9649
    def then
      then_loc&.slice
    end

def then: () -> `String`?

then_loc ()
Source

    # File lib/prism/node.rb, line 9625
    def then_loc
      location = @then_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @then_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

attr_reader `then_loc`: `Location`?

type ()
Source

    # File lib/prism/node.rb, line 9659
    def type
      :in_node
    end

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