class Prism::AlternationPatternNode - Documentation for Ruby 4.1
Description: class Prism::AlternationPatternNode: Represents an alternation pattern in pattern matching.
Keywords: ruby,class,Prism::AlternationPatternNode

🔍

No recent searches

# class Prism::AlternationPatternNode

Represents an alternation pattern in pattern matching.

    foo => bar | baz
           ^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, left, right, operator_loc)
Source

    # File lib/prism/node.rb, line 830
    def initialize(source, node_id, location, flags, left, right, operator_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @left = left
      @right = right
      @operator_loc = operator_loc
    end

Initialize a new `AlternationPatternNode` node.

### Public Instance Methods

left → Node
Source

    # File lib/prism/node.rb, line 937
    def left
      @left
    end

Represents the left side of the expression.

    foo => bar | baz
           ^^^

right → Node
Source

    # File lib/prism/node.rb, line 950
    def right
      @right
    end

Represents the right side of the expression.

    foo => bar | baz
                 ^^^

## Locations

### Public Instance Methods

operator_loc → Location
Source

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

Represents the alternation operator `Location`.

    foo => bar | baz
               ^

## 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 917
    def self.type
      :alternation_pattern_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 861
    def child_nodes
      [left, right]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 886
    def comment_targets
      [left, right, operator_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 879
    def compact_child_nodes
      [left, right]
    end

See `Node.compact_child_nodes`.

copy(**fields) → AlternationPatternNode
Source

    # File lib/prism/node.rb, line 896
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc)
      AlternationPatternNode.new(source, node_id, location, flags, left, right, operator_loc)
    end

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

deconstruct ()
Alias for: child_nodes
each_child_node () { |left| ... }
Source

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

      yield left
      yield right
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 910
    def type
      :alternation_pattern_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_operator_loc (repository)
Source

    # File lib/prism/node.rb, line 975
    def save_operator_loc(repository)
      repository.enter(node_id, :operator_loc)
    end

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

## Slicing

### Public Instance Methods

operator → String
Source

    # File lib/prism/node.rb, line 987
    def operator
      operator_loc.slice
    end

Slice the location of `operator_loc` from the source.