Struct PointerUninitialized<T>

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

Implements
Inherited Members
Namespace: SemPtr
Assembly: SemPtr.dll
Syntax
public readonly ref struct PointerUninitialized<T> : ITypedPointer<T, PointerUninitialized<T>>, ITypedPointer<T>, IPointer<PointerUninitialized<T>>, IPointer, IEquatable<PointerUninitialized<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, 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

PointerUninitialized<T> has the following characteristics:

  • Non-nullableYou can initialize the pointer's target directly without checking for null.
  • 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.

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

Constructors

Name Description
PointerUninitialized()

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.

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(PointerUninitialized<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(PointerUninitialized<T>) method instead.
FromIntPtr(nint)

Creates a PointerUninitialized<T> from a memory address given as a nint.
FromRaw(T*)

Creates a PointerUninitialized<T> from a raw pointer.
FromUIntPtr(nuint)

Creates a PointerUninitialized<T> from a memory address given as a nint.
GetHashCode()

Returns the hash code for this instance.
InitializeTarget(in T)

Initializes the target value the current pointer is pointing to with the specified value.
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 ==(PointerUninitialized<T>, NullableFunctionPointer)

Compares two values to determine equality.
operator ==(PointerUninitialized<T>, NullablePointerReadOnly)

Compares two values to determine equality.
operator ==(PointerUninitialized<T>, NullablePointerUninitialized)

Compares two values to determine equality.
operator ==(PointerUninitialized<T>, PointerUninitialized<T>)

Compares two values to determine equality.
explicit operator PointerUninitialized<T>(PersistentPointer)

Converts a PersistentPointer to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(PersistentPointerUninitialized)

Converts a PersistentPointerUninitialized to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(PersistentSequencePointer)

Converts a PersistentSequencePointer to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(PersistentSequencePointerUninitialized)

Converts a PersistentSequencePointerUninitialized to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(Pointer)

Converts a Pointer to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(PointerUninitialized)

Converts a PointerUninitialized to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(SequencePointer)

Converts a SequencePointer to a PointerUninitialized<T>.
explicit operator PointerUninitialized<T>(SequencePointerUninitialized)

Converts a SequencePointerUninitialized to a PointerUninitialized<T>.
operator false(PointerUninitialized<T>)

Determines whether the specified pointer is null.
implicit operator NullablePointerUninitialized(PointerUninitialized<T>)

Converts a PointerUninitialized<T> to a NullablePointerUninitialized.
implicit operator NullablePointerUninitialized<T>(PointerUninitialized<T>)

Converts a PointerUninitialized<T> to a NullablePointerUninitialized<T>.
implicit operator PointerUninitialized(PointerUninitialized<T>)

Converts a PointerUninitialized<T> to a PointerUninitialized.
operator !=(PointerUninitialized<T>, NullableFunctionPointer)

Compares two values to determine inequality.
operator !=(PointerUninitialized<T>, NullablePointerReadOnly)

Compares two values to determine inequality.
operator !=(PointerUninitialized<T>, NullablePointerUninitialized)

Compares two values to determine inequality.
operator !=(PointerUninitialized<T>, PointerUninitialized<T>)

Compares two values to determine inequality.
operator true(PointerUninitialized<T>)

Determines whether the specified pointer is non-null.