CodeQL library for Ruby
codeql/ruby-all 0.8.15-dev (changelog, source)
Search

Class ArrayPattern

An array pattern, for example:

in []
in ["first", Integer => x, "last"]
in ["a", Integer => x, *]
in ["a", Integer => x, ]
in [1, 2, *x, 7, 8]
in [*init, 7, 8]
in List["a", Integer => x, *tail]

Import path

import codeql.ruby.AST

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    allowsUnmatchedElements

    Holds if this pattern permits any unmatched remaining elements, i.e. the pattern does not have a trailing , and does not contain a rest token (* or *name) either.

    getAChild

    Gets a child of this node, which can also be retrieved using a predicate named pred.

    getAPrimaryQlClass

    Gets the name of a primary CodeQL class to which this node belongs.

    getClass

    Gets the class this pattern matches objects against, if any.

    getPrefixElement

    Gets the nth element of this list pattern’s prefix, i.e. the elements 1, ^two, 3 in the following examples: in [ 1, ^two, 3 ] in [ 1, ^two, 3, ] in [ 1, ^two, 3, *, 4 , 5] in [ 1, ^two, 3, *more]

    getRestVariableAccess

    Gets the variable of the rest token, if any. For example middle in `the following array pattern. rb [ 1, 2, 3, *middle, 4 , 5]

    getSuffixElement

    Gets the nth element of this list pattern’s suffix, i.e. the elements 4, 5 in the following examples: in [ *, 4, 5 ] in [ 1, 2, 3, *middle, 4 , 5]

    toString

    Gets a textual representation of this node.

    Inherited predicates

    getAChild

    Gets a child node of this AstNode.

    from AstNode
    getDesugared

    Gets the desugared version of this AST node, if any.

    from AstNode
    getEnclosingMethod

    Gets the enclosing method, if any.

    from AstNode
    getEnclosingModule

    Gets the enclosing module, if any.

    from AstNode
    getEnclosingToplevel

    Gets the enclosing top-level.

    from AstNode
    getFile

    Gets the file of this node.

    from AstNode
    getLocation

    Gets the location of this node.

    from AstNode
    getParent

    Gets the parent of this AstNode, if this node is not a root node.

    from AstNode
    getPrimaryQlClasses

    Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

    from AstNode
    isSynthesized

    Holds if this node was synthesized to represent an implicit AST node not present in the source code. In the following example method call, the receiver is an implicit self reference, for which there is a synthesized Self node.

    from AstNode

    Charpred