Class TruffleString.StringSet

java.lang.Object

com.oracle.truffle.api.strings.TruffleString.StringSet

Enclosing class:

TruffleString

public static final class TruffleString.StringSet
extends Object

A set of strings in a given encoding. Used in TruffleString.ByteIndexOfStringSetNode.execute(AbstractTruffleString, int, int, TruffleString.StringSet).

Since:

25.1

Method Summary

Modifier and Type	Method	Description
static TruffleString.StringSet	fromArray(AbstractTruffleString[] strings, TruffleString.Encoding encoding)	Creates a new TruffleString.StringSet from the given array of strings.
static TruffleString.StringSet	fromArray(TruffleString.WithMask[] strings, TruffleString.Encoding encoding)	Creates a new TruffleString.StringSet from the given array of strings with masks.
boolean	isIntrinsicCandidate(TruffleString.CodeRange codeRange)	Returns true if TruffleString.ByteIndexOfStringSetNode may implement the search for this particular string set in strings with the given code range by dispatching to a compiler intrinsic.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fromArray

public static TruffleString.StringSet fromArray(AbstractTruffleString[] strings,
 TruffleString.Encoding encoding)

Creates a new TruffleString.StringSet from the given array of strings. This operation is expensive, it is recommended to cache the result.

Parameters:

strings - list of strings to search for. Empty and TruffleString.CodeRange.BROKEN strings are unsupported.

encoding - strings' encoding. Must be a supported encoding, i.e. UTF-8/16/32, TruffleString.Encoding.ISO_8859_1 or TruffleString.Encoding.US_ASCII.

Since:

25.1

fromArray

public static TruffleString.StringSet fromArray(TruffleString.WithMask[] strings,
 TruffleString.Encoding encoding)

Creates a new TruffleString.StringSet from the given array of strings with masks. This operation is expensive, it is recommended to cache the result. Matching uses the same semantics as TruffleString.WithMask with some additional restrictions: a pattern code unit matches a haystack code unit if (haystack | mask) == pattern, but the mask may only have one set bit per code unit, and it may not have a larger code range than all search patterns, e.g. if all strings are TruffleString.CodeRange.ASCII, the mask may not have a code unit 0x80. The restrictions of the maskless variant also apply here.

Since:

25.1

isIntrinsicCandidate

public boolean isIntrinsicCandidate(TruffleString.CodeRange codeRange)

Returns true if TruffleString.ByteIndexOfStringSetNode may implement the search for this particular string set in strings with the given code range by dispatching to a compiler intrinsic.

This is useful for use cases where the caller has a faster implementation for non-intrinsified paths.

Since:

25.1