Ruby 4.1.0dev (2026-11-16 revision 67814cf9b0f3a4bad6f7369b0c8e6fc69220de64)
pm_find_pattern_node Struct Reference

FindPatternNode. More...

#include <ast.h>

Data Fields

pm_node_t base
 The embedded base node.
PM_NODE_ALIGNAS struct pm_node * constant
 FindPatternNode#constant.
PM_NODE_ALIGNAS struct pm_splat_node * left
 FindPatternNode#left.
struct pm_node_list requireds
 FindPatternNode#requireds.
PM_NODE_ALIGNAS struct pm_splat_node * right
 FindPatternNode#right.
pm_location_t opening_loc
 FindPatternNode#opening_loc.
pm_location_t closing_loc
 FindPatternNode#closing_loc.
Data Fields inherited from pm_node
pm_node_type_t type
 This represents the type of the node.
pm_node_flags_t flags
 This represents any flags on the node.
uint32_t node_id
 The unique identifier for this node, which is deterministic based on the source.
pm_location_t location
 This is the location of the node in the source.

Detailed Description

FindPatternNode.

Represents a find pattern in pattern matching.

foo in *bar, baz, *qux
       ^^^^^^^^^^^^^^^

foo in [*bar, baz, *qux]
       ^^^^^^^^^^^^^^^^^

foo in Foo(*bar, baz, *qux)
       ^^^^^^^^^^^^^^^^^^^^

foo => *bar, baz, *qux
       ^^^^^^^^^^^^^^^

Type: ::PM_FIND_PATTERN_NODE

Definition at line 3850 of file ast.h.

Field Documentation

◆ base

pm_node_t pm_find_pattern_node::base

The embedded base node.

Definition at line 3852 of file ast.h.

◆ closing_loc

pm_location_t pm_find_pattern_node::closing_loc

FindPatternNode#closing_loc.

The Location of the closing brace.

foo in [*bar, baz, *qux]
                       ^

foo in Foo(*bar, baz, *qux)
                          ^

Definition at line 3927 of file ast.h.

◆ constant

PM_NODE_ALIGNAS struct pm_node* pm_find_pattern_node::constant

FindPatternNode#constant.

Represents the optional constant preceding the pattern

foo in Foo(*bar, baz, *qux)
       ^^^

Definition at line 3862 of file ast.h.

◆ left

PM_NODE_ALIGNAS struct pm_splat_node* pm_find_pattern_node::left

FindPatternNode#left.

Represents the first wildcard node in the pattern.

foo in *bar, baz, *qux
       ^^^^

foo in Foo(*bar, baz, *qux)
           ^^^^

Definition at line 3875 of file ast.h.

◆ opening_loc

pm_location_t pm_find_pattern_node::opening_loc

FindPatternNode#opening_loc.

The Location of the opening brace.

foo in [*bar, baz, *qux]
       ^

foo in Foo(*bar, baz, *qux)
          ^

Definition at line 3914 of file ast.h.

◆ requireds

struct pm_node_list pm_find_pattern_node::requireds

FindPatternNode#requireds.

Represents the nodes in between the wildcards.

foo in *bar, baz, *qux
             ^^^

foo in Foo(*bar, baz, 1, *qux)
                 ^^^^^^

Definition at line 3888 of file ast.h.

◆ right

PM_NODE_ALIGNAS struct pm_splat_node* pm_find_pattern_node::right

FindPatternNode#right.

Represents the second wildcard node in the pattern.

foo in *bar, baz, *qux
                  ^^^^

foo in Foo(*bar, baz, *qux)
                      ^^^^

Definition at line 3901 of file ast.h.


The documentation for this struct was generated from the following file: