Struct NullablePointerReadOnly<T>

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

Implements

IEquatable<NullablePointerReadOnly<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

ITypedPointer<T, NullablePointerReadOnly<T>>

ITypedPointer<T>

IPointer<NullablePointerReadOnly<T>>

IPointer

ISpanFormattable

IFormattable

IUtf8SpanFormattable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly ref struct NullablePointerReadOnly<T> : IEquatable<NullablePointerReadOnly<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, ITypedPointer<T, NullablePointerReadOnly<T>>, ITypedPointer<T>, IPointer<NullablePointerReadOnly<T>>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable where T : unmanaged, allows ref struct

Type Parameters

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

Remarks

NullablePointerReadOnly<T> has the following characteristics:

• null-ableYou must check whether the pointer is null using TryGetNonNull(out PointerReadOnly<T>) before accessing the pointer's target.
• TransientThe pointer's target is only valid for the lifetime of the pointer. You cannot let the pointer escape the current scope and you cannot access the pointer's target after the pointer's lifetime ends.
• 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 NullablePointerReadOnly<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(NullablePointerReadOnly)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePointerReadOnly<T>)	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(NullablePointerReadOnly<T>) method instead.
FromIntPtr(nint)	Creates a NullablePointerReadOnly<T> from a memory address given as a nint.
FromRaw(T*)	Creates a NullablePointerReadOnly<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a NullablePointerReadOnly<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 PointerReadOnly<T>)	Attempts to get a non-null pointer from the current pointer.

Operators

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