Struct PersistentPointerReadOnly

Represents a non-nullable persistent pointer pointing to a read-only target.

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

PersistentPointerReadOnly has the following characteristics:

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

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

Constructors

Name Description
PersistentPointerReadOnly()

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(PersistentPointerReadOnly)

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 PersistentPointerReadOnly from a memory address given as a nint.
FromRaw(void*)

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

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

Creates a PersistentPointerReadOnly 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.

Operators

Name Description
operator ==(PersistentPointerReadOnly, NullableFunctionPointer)

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

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

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

Compares two values to determine equality.
explicit operator FunctionPointer(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a FunctionPointer.
explicit operator NullableFunctionPointer(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a NullableFunctionPointer.
explicit operator NullablePersistentFunctionPointer(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a NullablePersistentFunctionPointer.
explicit operator PersistentFunctionPointer(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a PersistentFunctionPointer.
operator false(PersistentPointerReadOnly)

Determines whether the specified pointer is null.
implicit operator NullablePersistentPointerReadOnly(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a NullablePersistentPointerReadOnly.
implicit operator NullablePointerReadOnly(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a NullablePointerReadOnly.
implicit operator PointerReadOnly(PersistentPointerReadOnly)

Converts a PersistentPointerReadOnly to a PointerReadOnly.
operator !=(PersistentPointerReadOnly, NullableFunctionPointer)

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

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

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

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

Determines whether the specified pointer is non-null.