Struct NullablePointerReadOnly

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

Implements
Inherited Members
Namespace: SemPtr
Assembly: SemPtr.dll
Syntax
public readonly ref struct NullablePointerReadOnly : IPointer<NullablePointerReadOnly>, IPointer, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, ISpanFormattable, IFormattable, IUtf8SpanFormattable
Remarks

NullablePointerReadOnly has the following characteristics:

  • null-ableYou must check whether the pointer is null using TryGetNonNull(out PointerReadOnly) 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.
  • Read-onlyYou can only read the pointer's target. You cannot modify it.
  • UntypedThe pointer points to a single target of unknown type. You must cast the pointer to a specific type before you can access its target.

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 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(object?)

Not supported. Do not call this method, use the Equals(NullablePointerReadOnly) method instead.
FromIntPtr(nint)

Creates a NullablePointerReadOnly from a memory address given as a nint.
FromRaw(void*)

Creates a NullablePointerReadOnly from a raw pointer.
FromRaw<T>(T*)

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

Creates a NullablePointerReadOnly 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)

Attempts to get a non-null pointer from the current pointer.

Operators

Name Description
operator ==(NullablePointerReadOnly, NullableFunctionPointer)

Compares two values to determine equality.
operator ==(NullablePointerReadOnly, NullablePointerReadOnly)

Compares two values to determine equality.
operator ==(NullablePointerReadOnly, NullablePointerUninitialized)

Compares two values to determine equality.
explicit operator NullableFunctionPointer(NullablePointerReadOnly)

Converts a NullablePointerReadOnly to a NullableFunctionPointer.
operator false(NullablePointerReadOnly)

Determines whether the specified pointer is null.
operator !=(NullablePointerReadOnly, NullableFunctionPointer)

Compares two values to determine inequality.
operator !=(NullablePointerReadOnly, NullablePointerReadOnly)

Compares two values to determine inequality.
operator !=(NullablePointerReadOnly, NullablePointerUninitialized)

Compares two values to determine inequality.
operator true(NullablePointerReadOnly)

Determines whether the specified pointer is non-null.