Struct PointerReadOnly
Represents a non-nullable transient pointer pointing to a read-only target.
Implements
Inherited Members
Namespace: SemPtr
Assembly: SemPtr.dll
Syntax
public readonly ref struct PointerReadOnly : IPointer<PointerReadOnly>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEquatable<PointerReadOnly>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>Remarks
PointerReadOnly has the following characteristics:
- Non-
nullableYou can access the pointer's target directly without checking fornull. - 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.
You should never create instances of PointerReadOnly using its parameterless constructors or default(PointerReadOnly). Doing so will result in undefined behavior.
Always use the FromRaw(void*), FromIntPtr(nint), or FromUIntPtr(nuint) methods to create instances of PointerReadOnly pointers.
Constructors
| Name | Description |
|---|---|
| PointerReadOnly() | 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- |
| 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(PointerReadOnly) | 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(PointerReadOnly) method instead. |
| FromIntPtr(nint) | Creates a PointerReadOnly from a memory address given as a nint. |
| FromRaw(void*) | Creates a PointerReadOnly from a |
| FromRaw<T>(T*) | Creates a PointerReadOnly<T> from a |
| FromUIntPtr(nuint) | Creates a PointerReadOnly 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. |