Struct NullablePersistentPointerReadOnly<T>

Represents a null-able persistent pointer pointing to a read-only target of type T.

Implements

ITypedPointer<T, NullablePersistentPointerReadOnly<T>>

ITypedPointer<T>

IPointer<NullablePersistentPointerReadOnly<T>>

IPointer

IEquatable<NullablePersistentPointerReadOnly<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

IEqualityOperators<NullablePersistentPointerReadOnly<T>, NullablePersistentPointerReadOnly<T>, bool>

ISpanFormattable

IFormattable

IUtf8SpanFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

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

Type Parameters

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

Remarks

NullablePersistentPointerReadOnly<T> has the following characteristics:

• null-ableYou must check whether the pointer is null using TryGetNonNull(out PersistentPointerReadOnly<T>) before accessing the pointer's target.
• 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-onlyYou can only read the pointer's target. You cannot modify it.
• TypedThe pointer points to a single target of type T.

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.
Null	Gets a NullablePersistentPointerReadOnly<T> that represents a null pointer.
Raw	Gets a raw pointer pointing to the same target as the current pointer.

Methods

Name	Description
Equals(NullableFunctionPointer)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePersistentPointerReadOnly<T>)	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.
FromIntPtr(nint)	Creates a NullablePersistentPointerReadOnly<T> from a memory address given as a nint.
FromRaw(T*)	Creates a NullablePersistentPointerReadOnly<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a NullablePersistentPointerReadOnly<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.
TryGetNonNull(out PersistentPointerReadOnly<T>)	Attempts to get a non-null pointer from the current pointer.

Operators

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