class Prism::BreakNode - Documentation for Ruby 4.1
Description: class Prism::BreakNode: Represents the use of the `break` keyword.
Keywords: ruby,class,Prism::BreakNode

🔍

No recent searches

# class Prism::BreakNode

Represents the use of the `break` keyword.

    break foo
    ^^^^^^^^^

### Public Class Methods

new (source, node_id, location, flags, arguments, keyword_loc)
Source

    # File lib/prism/node.rb, line 3679
    def initialize(source, node_id, location, flags, arguments, keyword_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @arguments = arguments
      @keyword_loc = keyword_loc
    end

Initialize a new `BreakNode` node.

### Public Instance Methods

arguments → ArgumentsNode | nil
Source

    # File lib/prism/node.rb, line 3786
    def arguments
      @arguments
    end

The arguments to the break statement, if present. These can be any non-void expressions.

    break foo
          ^^^

## Locations

### Public Instance Methods

keyword_loc → Location
Source

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

The `Location` of the `break` keyword.

    break foo
    ^^^^^

## 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 3766
    def self.type
      :break_node
    end

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

    # File lib/prism/node.rb, line 3709
    def child_nodes
      [arguments]
    end

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 3735
    def comment_targets
      [*arguments, keyword_loc] #: Array[Prism::node | Location]
    end

See `Node.comment_targets`.

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 3726
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      if (arguments = self.arguments); compact << arguments; end
      compact
    end

See `Node.compact_child_nodes`.

copy(**fields) → BreakNode
Source

    # File lib/prism/node.rb, line 3745
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, arguments: self.arguments, keyword_loc: self.keyword_loc)
      BreakNode.new(source, node_id, location, flags, arguments, keyword_loc)
    end

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

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

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

      if (arguments = self.arguments); yield arguments; end
    end

See `Node.each_child_node`.

type ()
Source

    # File lib/prism/node.rb, line 3759
    def type
      :break_node
    end

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 3811
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

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

## Slicing

### Public Instance Methods

keyword → String
Source

    # File lib/prism/node.rb, line 3823
    def keyword
      keyword_loc.slice
    end

Slice the location of `keyword_loc` from the source.