Struct PersistentPointer<T>

Represents a non-nullable persistent pointer pointing to a target of type T.

Implements

ITypedPointer<T, PersistentPointer<T>>

ITypedPointer<T>

IPointer<PersistentPointer<T>>

IPointer

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IEquatable<PersistentPointer<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

IEqualityOperators<PersistentPointer<T>, PersistentPointer<T>, bool>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly struct PersistentPointer<T> : ITypedPointer<T, PersistentPointer<T>>, ITypedPointer<T>, IPointer<PersistentPointer<T>>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEquatable<PersistentPointer<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, IEqualityOperators<PersistentPointer<T>, PersistentPointer<T>, bool> where T : unmanaged

Type Parameters

Name	Description
T	The type of the target that the pointer points to.

Remarks

PersistentPointer<T> has the following characteristics:

• Non-nullableYou can access the pointer's target directly without checking for null.
• PersistentThe pointer's target outlives the pointer's initial scope. You can let the pointer escape the current scope and store it for later access. No guarantees are made about how long the target will remain valid or who owns it.
• Single objectThe pointer points to a single target. You can only access that target directly. You cannot perform pointer arithmetic with the pointer.
• Read-writeYou can read and write the pointer's target.
• TypedThe pointer points to a single target of type T.

You should never create instances of PersistentPointer<T> using its parameterless constructors or default(PersistentPointer<T>). Doing so will result in undefined behavior. Always use the FromRaw(T*), FromIntPtr(nint), or FromUIntPtr(nuint) methods to create instances of PersistentPointer<T> pointers.

Constructors

Name	Description
PersistentPointer()	Do not use. Do not create instances of non-nullable pointers using parameterless constructors or default values.

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.
HasTarget	Gets a value indicating whether the current pointer is non-null.
Raw	Gets a raw pointer pointing to the same target as the current pointer.
Target	Gets a reference to the target value the current pointer is pointing to.

Methods

Name	Description
Equals(NullableFunctionPointer)	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(PersistentPointer<T>)	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.
FromIntPtr(nint)	Creates a PersistentPointer<T> from a memory address given as a nint.
FromRaw(T*)	Creates a PersistentPointer<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a PersistentPointer<T> 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.

Operators

Name	Description
operator ==(PersistentPointer<T>, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(PersistentPointer<T>, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(PersistentPointer<T>, NullablePointerUninitialized)	Compares two values to determine equality.
operator ==(PersistentPointer<T>, PersistentPointer<T>)	Compares two values to determine equality.
explicit operator PersistentPointer<T>(PersistentPointer)	Converts a PersistentPointer to a PersistentPointer<T>.
explicit operator FunctionPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a FunctionPointer.
explicit operator NullableFunctionPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullableFunctionPointer.
explicit operator NullablePersistentFunctionPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentFunctionPointer.
explicit operator PersistentFunctionPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentFunctionPointer.
explicit operator PersistentPointer<T>(PersistentSequencePointer)	Converts a PersistentSequencePointer to a PersistentPointer<T>.
operator false(PersistentPointer<T>)	Determines whether the specified pointer is null.
implicit operator NullablePersistentPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointer.
implicit operator NullablePersistentPointerReadOnly(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointerReadOnly.
implicit operator NullablePersistentPointerReadOnly<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointerReadOnly<T>.
implicit operator NullablePersistentPointerUninitialized(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointerUninitialized.
implicit operator NullablePersistentPointerUninitialized<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointerUninitialized<T>.
implicit operator NullablePersistentPointer<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePersistentPointer<T>.
implicit operator NullablePointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointer.
implicit operator NullablePointerReadOnly(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointerReadOnly.
implicit operator NullablePointerReadOnly<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointerReadOnly<T>.
implicit operator NullablePointerUninitialized(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointerUninitialized.
implicit operator NullablePointerUninitialized<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointerUninitialized<T>.
implicit operator NullablePointer<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a NullablePointer<T>.
implicit operator PersistentPointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentPointer.
implicit operator PersistentPointerReadOnly(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentPointerReadOnly.
implicit operator PersistentPointerReadOnly<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentPointerReadOnly<T>.
implicit operator PersistentPointerUninitialized(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentPointerUninitialized.
implicit operator PersistentPointerUninitialized<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PersistentPointerUninitialized<T>.
implicit operator Pointer(PersistentPointer<T>)	Converts a PersistentPointer<T> to a Pointer.
implicit operator PointerReadOnly(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PointerReadOnly.
implicit operator PointerReadOnly<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PointerReadOnly<T>.
implicit operator PointerUninitialized(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PointerUninitialized.
implicit operator PointerUninitialized<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a PointerUninitialized<T>.
implicit operator Pointer<T>(PersistentPointer<T>)	Converts a PersistentPointer<T> to a Pointer<T>.
operator !=(PersistentPointer<T>, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(PersistentPointer<T>, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(PersistentPointer<T>, NullablePointerUninitialized)	Compares two values to determine inequality.
operator !=(PersistentPointer<T>, PersistentPointer<T>)	Compares two values to determine inequality.
operator true(PersistentPointer<T>)	Determines whether the specified pointer is non-null.