Struct NullablePointerUninitialized<T>

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

Implements

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IEquatable<NullablePointerUninitialized<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

ITypedPointer<T, NullablePointerUninitialized<T>>

ITypedPointer<T>

IPointer<NullablePointerUninitialized<T>>

IPointer

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

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

Type Parameters

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

Remarks

NullablePointerUninitialized<T> has the following characteristics:

• null-ableYou must check whether the pointer is null using TryGetNonNull(out PointerUninitialized<T>) before initializing 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.
• UninitializedThe pointer's target is uninitialized and you should initialize it. You cannot read it before writing to 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 NullablePointerUninitialized<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(NullablePointerUninitialized)	Indicates whether the current object is equal to another object of the same type.
Equals(NullablePointerUninitialized<T>)	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(NullablePointerUninitialized<T>) method instead.
FromIntPtr(nint)	Creates a NullablePointerUninitialized<T> from a memory address given as a nint.
FromRaw(T*)	Creates a NullablePointerUninitialized<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a NullablePointerUninitialized<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 PointerUninitialized<T>)	Attempts to get a non-null pointer from the current pointer.

Operators

Name	Description
operator ==(NullablePointerUninitialized<T>, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(NullablePointerUninitialized<T>, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(NullablePointerUninitialized<T>, NullablePointerUninitialized)	Compares two values to determine equality.
operator ==(NullablePointerUninitialized<T>, NullablePointerUninitialized<T>)	Compares two values to determine equality.
explicit operator NullablePointerUninitialized<T>(NullablePersistentPointer)	Converts a NullablePersistentPointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullablePersistentPointerUninitialized)	Converts a NullablePersistentPointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullablePersistentSequencePointer)	Converts a NullablePersistentSequencePointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullablePersistentSequencePointerUninitialized)	Converts a NullablePersistentSequencePointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullablePointer)	Converts a NullablePointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullablePointerUninitialized)	Converts a NullablePointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullableSequencePointer)	Converts a NullableSequencePointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(NullableSequencePointerUninitialized)	Converts a NullableSequencePointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(PersistentPointer)	Converts a PersistentPointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(PersistentPointerUninitialized)	Converts a PersistentPointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(PersistentSequencePointer)	Converts a PersistentSequencePointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(PersistentSequencePointerUninitialized)	Converts a PersistentSequencePointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(Pointer)	Converts a Pointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(PointerUninitialized)	Converts a PointerUninitialized to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(SequencePointer)	Converts a SequencePointer to a NullablePointerUninitialized<T>.
explicit operator NullablePointerUninitialized<T>(SequencePointerUninitialized)	Converts a SequencePointerUninitialized to a NullablePointerUninitialized<T>.
operator false(NullablePointerUninitialized<T>)	Determines whether the specified pointer is null.
implicit operator NullablePointerUninitialized(NullablePointerUninitialized<T>)	Converts a NullablePointerUninitialized<T> to a NullablePointerUninitialized.
operator !=(NullablePointerUninitialized<T>, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(NullablePointerUninitialized<T>, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(NullablePointerUninitialized<T>, NullablePointerUninitialized)	Compares two values to determine inequality.
operator !=(NullablePointerUninitialized<T>, NullablePointerUninitialized<T>)	Compares two values to determine inequality.
operator true(NullablePointerUninitialized<T>)	Determines whether the specified pointer is non-null.