Struct NullablePersistentPointerReadOnly

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

Implements

IPointer<NullablePersistentPointerReadOnly>

IPointer

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IEquatable<NullablePersistentPointerReadOnly>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

IEqualityOperators<NullablePersistentPointerReadOnly, NullablePersistentPointerReadOnly, bool>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly struct NullablePersistentPointerReadOnly : IPointer<NullablePersistentPointerReadOnly>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEquatable<NullablePersistentPointerReadOnly>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, IEqualityOperators<NullablePersistentPointerReadOnly, NullablePersistentPointerReadOnly, bool>

Remarks

NullablePersistentPointerReadOnly has the following characteristics:

• null-ableYou must check whether the pointer is null using TryGetNonNull(out PersistentPointerReadOnly) before accessing the pointer's target.
• 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.

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 NullablePersistentPointerReadOnly 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(NullablePersistentPointerReadOnly)	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?)	Indicates whether this instance and a specified object are equal.
FromIntPtr(nint)	Creates a NullablePersistentPointerReadOnly from a memory address given as a nint.
FromRaw(void*)	Creates a NullablePersistentPointerReadOnly from a raw pointer.
FromRaw<T>(T*)	Creates a NullablePersistentPointerReadOnly<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a NullablePersistentPointerReadOnly 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 PersistentPointerReadOnly)	Attempts to get a non-null pointer from the current pointer.

Operators

Name	Description
operator ==(NullablePersistentPointerReadOnly, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(NullablePersistentPointerReadOnly, NullablePersistentPointerReadOnly)	Compares two values to determine equality.
operator ==(NullablePersistentPointerReadOnly, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(NullablePersistentPointerReadOnly, NullablePointerUninitialized)	Compares two values to determine equality.
explicit operator NullableFunctionPointer(NullablePersistentPointerReadOnly)	Converts a NullablePersistentPointerReadOnly to a NullableFunctionPointer.
explicit operator NullablePersistentFunctionPointer(NullablePersistentPointerReadOnly)	Converts a NullablePersistentPointerReadOnly to a NullablePersistentFunctionPointer.
operator false(NullablePersistentPointerReadOnly)	Determines whether the specified pointer is null.
implicit operator NullablePointerReadOnly(NullablePersistentPointerReadOnly)	Converts a NullablePersistentPointerReadOnly to a NullablePointerReadOnly.
operator !=(NullablePersistentPointerReadOnly, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(NullablePersistentPointerReadOnly, NullablePersistentPointerReadOnly)	Compares two values to determine inequality.
operator !=(NullablePersistentPointerReadOnly, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(NullablePersistentPointerReadOnly, NullablePointerUninitialized)	Compares two values to determine inequality.
operator true(NullablePersistentPointerReadOnly)	Determines whether the specified pointer is non-null.