Struct NullableFunctionPointer<TDelegate>

Represents a null-able transient function pointer pointing to a target function whose signature is represented by TDelegate

Implements

IEquatable<NullableFunctionPointer<TDelegate>>

IEquatable<NullableFunctionPointer>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

ISpanFormattable

IFormattable

IUtf8SpanFormattable

ITypedFunctionPointer<TDelegate, NullableFunctionPointer<TDelegate>>

ITypedFunctionPointer<TDelegate>

IFunctionPointer<NullableFunctionPointer<TDelegate>>

IFunctionPointer

IPointer<NullableFunctionPointer<TDelegate>>

IPointer

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly ref struct NullableFunctionPointer<TDelegate> : IEquatable<NullableFunctionPointer<TDelegate>>, IEquatable<NullableFunctionPointer>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, ISpanFormattable, IFormattable, IUtf8SpanFormattable, ITypedFunctionPointer<TDelegate, NullableFunctionPointer<TDelegate>>, ITypedFunctionPointer<TDelegate>, IFunctionPointer<NullableFunctionPointer<TDelegate>>, IFunctionPointer, IPointer<NullableFunctionPointer<TDelegate>>, IPointer where TDelegate : notnull, Delegate

Type Parameters

Name	Description
TDelegate	The type of the delegate representing the signature of the target function that this pointer points to.

Remarks

NullableFunctionPointer<TDelegate> has the following characteristics:

• null-ableYou must check whether the function pointer is null using TryGetNonNull(out FunctionPointer<TDelegate>) before invoking the function pointer's target function.
• TransientThe function pointer's target function is only valid for the lifetime of the pointer. You cannot let the function pointer escape the current scope and you cannot invoke the function pointer's target function after the pointer's lifetime ends.
• TypedThe function pointer points to a target function whose signature is represented by TDelegate.

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 NullableFunctionPointer<TDelegate> that represents a null pointer.

Methods

Name	Description
Equals(NullableFunctionPointer)	Indicates whether the current object is equal to another object of the same type.
Equals(NullableFunctionPointer<TDelegate>)	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?)	Not supported. Do not call this method, use the Equals(NullableFunctionPointer<TDelegate>) method instead.
FromDelegate(TDelegate?)	Creates a NullableFunctionPointer<TDelegate> from a delegate of type TDelegate.
FromIntPtr(nint)	Creates a NullableFunctionPointer<TDelegate> from a memory address given as a nint.
FromUIntPtr(nuint)	Creates a NullableFunctionPointer<TDelegate> from a memory address given as a nint.
GetHashCode()	Returns the hash code for this instance.
ToDelegate()	Converts the current function pointer to a delegate of type TDelegate.
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 FunctionPointer<TDelegate>)	Attempts to get a non-null function pointer from the current function pointer.

Operators

Name	Description
operator ==(NullableFunctionPointer<TDelegate>, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(NullableFunctionPointer<TDelegate>, NullableFunctionPointer<TDelegate>)	Compares two values to determine equality.
operator ==(NullableFunctionPointer<TDelegate>, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(NullableFunctionPointer<TDelegate>, NullablePointerUninitialized)	Compares two values to determine equality.
explicit operator NullableFunctionPointer<TDelegate>(FunctionPointer)	Converts a FunctionPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullableFunctionPointer)	Converts a NullableFunctionPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullablePointerReadOnly(NullableFunctionPointer<TDelegate>)	Converts a NullableFunctionPointer<TDelegate> to a NullablePointerReadOnly.
explicit operator NullableFunctionPointer<TDelegate>(NullablePersistentFunctionPointer)	Converts a NullablePersistentFunctionPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePersistentPointer)	Converts a NullablePersistentPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePersistentPointerReadOnly)	Converts a NullablePersistentPointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePersistentSequencePointer)	Converts a NullablePersistentSequencePointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePersistentSequencePointerReadOnly)	Converts a NullablePersistentSequencePointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePointer)	Converts a NullablePointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullablePointerReadOnly)	Converts a NullablePointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullableSequencePointer)	Converts a NullableSequencePointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(NullableSequencePointerReadOnly)	Converts a NullableSequencePointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PersistentFunctionPointer)	Converts a PersistentFunctionPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PersistentPointer)	Converts a PersistentPointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PersistentPointerReadOnly)	Converts a PersistentPointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PersistentSequencePointer)	Converts a PersistentSequencePointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PersistentSequencePointerReadOnly)	Converts a PersistentSequencePointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(Pointer)	Converts a Pointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(PointerReadOnly)	Converts a PointerReadOnly to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(SequencePointer)	Converts a SequencePointer to a NullableFunctionPointer<TDelegate>.
explicit operator NullableFunctionPointer<TDelegate>(SequencePointerReadOnly)	Converts a SequencePointerReadOnly to a NullableFunctionPointer<TDelegate>.
operator false(NullableFunctionPointer<TDelegate>)	Determines whether the specified function pointer is null.
implicit operator NullableFunctionPointer(NullableFunctionPointer<TDelegate>)	Converts a NullableFunctionPointer<TDelegate> to a NullableFunctionPointer.
operator !=(NullableFunctionPointer<TDelegate>, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(NullableFunctionPointer<TDelegate>, NullableFunctionPointer<TDelegate>)	Compares two values to determine inequality.
operator !=(NullableFunctionPointer<TDelegate>, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(NullableFunctionPointer<TDelegate>, NullablePointerUninitialized)	Compares two values to determine inequality.
operator true(NullableFunctionPointer<TDelegate>)	Determines whether the specified function pointer is non-null.