Struct NullablePersistentSequencePointerReadOnly<T>
Represents a null-able persistent pointer pointing to a read-only contiguous sequence of targets of type T.
Implements
Inherited Members
Namespace: SemPtr
Assembly: SemPtr.dll
Syntax
public readonly struct NullablePersistentSequencePointerReadOnly<T> : IEquatable<NullablePersistentSequencePointerReadOnly<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, IIncrementOperators<NullablePersistentSequencePointerReadOnly<T>>, IDecrementOperators<NullablePersistentSequencePointerReadOnly<T>>, IAdditionOperators<NullablePersistentSequencePointerReadOnly<T>, nint, NullablePersistentSequencePointerReadOnly<T>>, IAdditionOperators<NullablePersistentSequencePointerReadOnly<T>, nuint, NullablePersistentSequencePointerReadOnly<T>>, ISubtractionOperators<NullablePersistentSequencePointerReadOnly<T>, nint, NullablePersistentSequencePointerReadOnly<T>>, ISubtractionOperators<NullablePersistentSequencePointerReadOnly<T>, nuint, NullablePersistentSequencePointerReadOnly<T>>, ISubtractionOperators<NullablePersistentSequencePointerReadOnly<T>, NullablePersistentSequencePointerReadOnly<T>, nint>, ITypedPointer<T, NullablePersistentSequencePointerReadOnly<T>>, ITypedPointer<T>, IPointer<NullablePersistentSequencePointerReadOnly<T>>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IComparable, IComparable<NullablePersistentSequencePointerReadOnly<T>>, IComparable<NullablePointerReadOnly>, IComparable<NullablePointerUninitialized>, IComparisonOperators<NullablePersistentSequencePointerReadOnly<T>, NullablePersistentSequencePointerReadOnly<T>, bool>, IEqualityOperators<NullablePersistentSequencePointerReadOnly<T>, NullablePersistentSequencePointerReadOnly<T>, bool> where T : unmanaged
Type Parameters
| Name | Description |
|---|---|
| T | The type of the target that the pointer points to. |
Remarks
NullablePersistentSequencePointerReadOnly<T> has the following characteristics:
null-ableYou must check whether the pointer isnullusing TryGetNonNull(out PersistentSequencePointerReadOnly<T>) 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.
- Contiguous sequenceThe pointer points to a contiguous sequence of targets. You can access the pointer's target objects individually via indexing. You can perform pointer arithmetic with the pointer.
- Read-onlyYou can only read the pointer's targets. You cannot modify them.
- TypedThe pointer points to a contiguous sequence of targets of type
T.
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 | Gets a NullablePersistentSequencePointerReadOnly<T> that represents a |
| Raw | Gets a raw pointer pointing to the same target as the current pointer. |
Methods
| Name | Description |
|---|---|
| CompareTo(NullablePersistentSequencePointerReadOnly<T>) | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| CompareTo(NullablePointerReadOnly) | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| CompareTo(NullablePointerUninitialized) | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| CompareTo(object?) | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| Equals(NullableFunctionPointer) | Indicates whether the current object is equal to another object of the same type. |
| Equals(NullablePersistentSequencePointerReadOnly<T>) | 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 NullablePersistentSequencePointerReadOnly<T> from a memory address given as a nint. |
| FromRaw(T*) | Creates a NullablePersistentSequencePointerReadOnly<T> from a |
| FromUIntPtr(nuint) | Creates a NullablePersistentSequencePointerReadOnly<T> 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 PersistentSequencePointerReadOnly<T>) | Attempts to get a non- |