RegExMatch

    Contains the results of a RegEx search.

    RegExMatch.swift:11
    class RegExMatch

    Contains the results of a single RegEx match returned by search(subject:offset:end:) and searchAll(subject:offset:end:). It can be used to find the position and range of the match and its capturing groups, and it can extract its substring for you.

    Superclasses

    Citizens in SwiftGodot

    Conformances

    • protocol CustomStringConvertible

      A type with a customized textual representation.

    • protocol Equatable

      A type that can be compared for value equality.

    • protocol Hashable

      A type that can be hashed into a Hasher to produce an integer hash value.

    • protocol Identifiable<ID>

      A class of types whose instances hold the value of an entity with stable identity.

    • protocol VariantRepresentable

      Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

    • protocol VariantStorable

      Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

    Type members

    Instance members

    • var names: GDictionary

      A dictionary of named groups and its corresponding group number. Only groups that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.

    • var strings: PackedStringArray

      An GArray of the match and its capturing groups.

    • var subject: String

      The source string used with the search pattern to find this matching result.

    • func getEnd(name: Variant) -> Int32

      Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

    • func getGroupCount() -> Int32

      Returns the number of capturing groups.

    • func getStart(name: Variant) -> Int32

      Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.

    • func getString(name: Variant) -> String

      Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it’s a named group). The default value of 0 refers to the whole pattern.