Class TruffleString.GetInternalNativePointerNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.strings.TruffleString.GetInternalNativePointerNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

TruffleString

public abstract static class TruffleString.GetInternalNativePointerNode
extends Node

Node to get a native string's pointer object or raw pointer. See execute(AbstractTruffleString, TruffleString.Encoding) for details.

Since:

22.1

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Method Summary

Modifier and Type	Method	Description
static TruffleString.GetInternalNativePointerNode	create()	Create a new TruffleString.GetInternalNativePointerNode.
abstract Object	execute(AbstractTruffleString a, TruffleString.Encoding expectedEncoding)	Get the given string's pointer object which was passed to TruffleString.FromNativePointerNode.
static TruffleString.GetInternalNativePointerNode	getUncached()	Get the uncached version of TruffleString.GetInternalNativePointerNode.

Methods inherited from class Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, reportReplace, toString

Methods inherited from class Object

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

Method Details

execute

public abstract Object execute(AbstractTruffleString a,
 TruffleString.Encoding expectedEncoding)

Get the given string's pointer object which was passed to TruffleString.FromNativePointerNode. If the string was created from a boxed Long raw native pointer, this node returns that raw pointer as a boxed Long. In that case, there is no associated object kept alive for lifetime tracking, so the caller remains responsible for ensuring that the native memory remains valid. If the string is not backed by a native pointer, this node will throw an UnsupportedOperationException. Use AbstractTruffleString.isNative() to check whether the string is actually backed by a native pointer before calling this node. Caution: If the given string is a TruffleString, the native pointer must not be modified as long as the string is used.

Since:

22.1

create

public static TruffleString.GetInternalNativePointerNode create()

Create a new TruffleString.GetInternalNativePointerNode.

Since:

22.1

getUncached

public static TruffleString.GetInternalNativePointerNode getUncached()

Get the uncached version of TruffleString.GetInternalNativePointerNode.

Since:

22.1