class Prism::UntilNode - Documentation for Ruby 4.0
Description: class Prism::UntilNode: Represents the use of the `until` keyword, either in the block form or the modifier form.
Keywords: ruby,class,Prism::UntilNode

🔍

No recent searches

# class Prism::UntilNode

Represents the use of the `until` keyword, either in the block form or the modifier form.

    bar until foo
    ^^^^^^^^^^^^^

    until foo do bar end
    ^^^^^^^^^^^^^^^^^^^^

### Attributes

predicate [R]

attr_reader predicate: Prism::node

statements [R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

new (source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements)
Source

    # File lib/prism/node.rb, line 18998
    def initialize(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @keyword_loc = keyword_loc
      @do_keyword_loc = do_keyword_loc
      @closing_loc = closing_loc
      @predicate = predicate
      @statements = statements
    end

Initialize a new `UntilNode` node.

type ()
Source

    # File lib/prism/node.rb, line 19142
    def self.type
      :until_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 19148
    def ===(other)
      other.is_a?(UntilNode) &&
        (flags === other.flags) &&
        (keyword_loc.nil? == other.keyword_loc.nil?) &&
        (do_keyword_loc.nil? == other.do_keyword_loc.nil?) &&
        (closing_loc.nil? == other.closing_loc.nil?) &&
        (predicate === other.predicate) &&
        (statements === other.statements)
    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 19011
    def accept(visitor)
      visitor.visit_until_node(self)
    end

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

begin_modifier? ()
Source

    # File lib/prism/node.rb, line 19055
    def begin_modifier?
      flags.anybits?(LoopFlags::BEGIN_MODIFIER)
    end

def begin_modifier?: () -> bool

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

    # File lib/prism/node.rb, line 19127
    def closing
      closing_loc&.slice
    end

def closing: () -> `String`?

closing_loc ()
Source

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

attr_reader `closing_loc`: `Location`?

comment_targets ()
Source

    # File lib/prism/node.rb, line 19037
    def comment_targets
      [keyword_loc, *do_keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements)
Source

    # File lib/prism/node.rb, line 19042
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements)
      UntilNode.new(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?keyword_loc: `Location`, ?do_keyword_loc: `Location`?, ?closing_loc: `Location`?, ?predicate: Prism::node, ?statements: `StatementsNode`?) -> `UntilNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 19050
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, keyword_loc: keyword_loc, do_keyword_loc: do_keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, `keyword_loc`: `Location`, `do_keyword_loc`: `Location`?, `closing_loc`: `Location`?, predicate: Prism::node, statements: `StatementsNode`? }

do_keyword ()
Source

    # File lib/prism/node.rb, line 19122
    def do_keyword
      do_keyword_loc&.slice
    end

def `do_keyword`: () -> `String`?

do_keyword_loc ()
Source

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

attr_reader `do_keyword_loc`: `Location`?

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

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

      yield predicate
      yield statements if statements
    end

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

inspect ()
Source

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

def inspect -> `String`

keyword ()
Source

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

def keyword: () -> `String`

keyword_loc ()
Source

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

attr_reader `keyword_loc`: `Location`

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 19106
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

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

save_do_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 19087
    def save_do_keyword_loc(repository)
      repository.enter(node_id, :do_keyword_loc) unless @do_keyword_loc.nil?
    end

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

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 19068
    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.

type ()
Source

    # File lib/prism/node.rb, line 19137
    def type
      :until_node
    end

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