Struct NullablePersistentFunctionPointer

Represents a null-able persistent function pointer pointing to a target function

Implements

IEquatable<NullablePersistentFunctionPointer>

IEquatable<NullableFunctionPointer>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEqualityOperators<NullablePersistentFunctionPointer, NullablePersistentFunctionPointer, bool>

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IFunctionPointer<NullablePersistentFunctionPointer>

IFunctionPointer

IPointer<NullablePersistentFunctionPointer>

IPointer

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly struct NullablePersistentFunctionPointer : IEquatable<NullablePersistentFunctionPointer>, IEquatable<NullableFunctionPointer>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEqualityOperators<NullablePersistentFunctionPointer, NullablePersistentFunctionPointer, bool>, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IFunctionPointer<NullablePersistentFunctionPointer>, IFunctionPointer, IPointer<NullablePersistentFunctionPointer>, IPointer

Remarks

NullablePersistentFunctionPointer has the following characteristics:

• null-ableYou must check whether the function pointer is null using TryGetNonNull(out PersistentFunctionPointer) before invoking the function pointer's target function.
• PersistentThe function pointer's target function outlives the pointer's initial scope. You can let the function pointer escape the current scope and store it for later invocation. No guarantees are made about how long the target function will remain valid.
• UntypedThe function pointer points to a target function of unknown signature. You must cast the function pointer to a specific type before you can invoke its target function.

Properties

Name	Description
AsIntPtr	Gets an nint that represents the same memory address as the current pointer.
AsUIntPtr	Gets an nuint that represents the same memory address as the current pointer.
HasTargetFunction	Gets a value indicating whether the current function pointer is non-null.
Null	Gets a NullablePersistentFunctionPointer that represents a null pointer.
Raw	Gets a raw pointer pointing to the same target function as the current pointer.

Methods

Name	Description
Equals(NullableFunctionPointer)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePersistentFunctionPointer)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePointerReadOnly)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePointerUninitialized)	Indicates whether the current object is equal to another object of the same type.
Equals(object?)	Indicates whether this instance and a specified object are equal.
FromDelegate<TDelegate>(TDelegate?)	Creates a NullablePersistentFunctionPointer<TDelegate> from a delegate of type TDelegate.
FromIntPtr(nint)	Creates a NullablePersistentFunctionPointer from a memory address given as a nint.
FromRaw(void*)	Creates a NullablePersistentFunctionPointer from a raw pointer.
FromUIntPtr(nuint)	Creates a NullablePersistentFunctionPointer from a memory address given as a nint.
GetHashCode()	Returns the hash code for this instance.
ToString()	Formats the value of the current instance using the default format.
ToString(IFormatProvider?)	Formats the value of the current instance using the specified format.
ToString(string?)	Formats the value of the current instance using the specified format.
ToString(string?, IFormatProvider?)	Formats the value of the current instance using the specified format.
TryFormat(Span<byte>, out int, IFormatProvider?)	Tries to format the value of the current instance as UTF-8 into the provided span of bytes.
TryFormat(Span<byte>, out int, ReadOnlySpan<char>, IFormatProvider?)	Tries to format the value of the current instance as UTF-8 into the provided span of bytes.
TryFormat(Span<char>, out int, IFormatProvider?)	Tries to format the value of the current instance into the provided span of characters.
TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider?)	Tries to format the value of the current instance into the provided span of characters.
TryGetNonNull(out PersistentFunctionPointer)	Attempts to get a non-null function pointer from the current function pointer.

Operators

Name	Description
operator ==(NullablePersistentFunctionPointer, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(NullablePersistentFunctionPointer, NullablePersistentFunctionPointer)	Compares two values to determine equality.
operator ==(NullablePersistentFunctionPointer, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(NullablePersistentFunctionPointer, NullablePointerUninitialized)	Compares two values to determine equality.
explicit operator NullablePersistentPointerReadOnly(NullablePersistentFunctionPointer)	Converts a NullablePersistentFunctionPointer to a NullablePersistentPointerReadOnly.
explicit operator NullablePointerReadOnly(NullablePersistentFunctionPointer)	Converts a NullablePersistentFunctionPointer to a NullablePointerReadOnly.
operator false(NullablePersistentFunctionPointer)	Determines whether the specified function pointer is null.
implicit operator NullableFunctionPointer(NullablePersistentFunctionPointer)	Converts a NullablePersistentFunctionPointer to a NullableFunctionPointer.
operator !=(NullablePersistentFunctionPointer, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(NullablePersistentFunctionPointer, NullablePersistentFunctionPointer)	Compares two values to determine inequality.
operator !=(NullablePersistentFunctionPointer, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(NullablePersistentFunctionPointer, NullablePointerUninitialized)	Compares two values to determine inequality.
operator true(NullablePersistentFunctionPointer)	Determines whether the specified function pointer is non-null.