Struct PersistentSequencePointerReadOnly<T>

Represents a non-nullable persistent pointer pointing to a read-only contiguous sequence of targets of type T.

Implements

IComparable

IComparable<PersistentSequencePointerReadOnly<T>>

IComparable<NullablePointerReadOnly>

IComparable<NullablePointerUninitialized>

IComparisonOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, bool>

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IIncrementOperators<PersistentSequencePointerReadOnly<T>>

IDecrementOperators<PersistentSequencePointerReadOnly<T>>

IAdditionOperators<PersistentSequencePointerReadOnly<T>, nint, PersistentSequencePointerReadOnly<T>>

IAdditionOperators<PersistentSequencePointerReadOnly<T>, nuint, PersistentSequencePointerReadOnly<T>>

ISubtractionOperators<PersistentSequencePointerReadOnly<T>, nint, PersistentSequencePointerReadOnly<T>>

ISubtractionOperators<PersistentSequencePointerReadOnly<T>, nuint, PersistentSequencePointerReadOnly<T>>

ISubtractionOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, nint>

ITypedPointer<T, PersistentSequencePointerReadOnly<T>>

ITypedPointer<T>

IPointer<PersistentSequencePointerReadOnly<T>>

IPointer

IEquatable<PersistentSequencePointerReadOnly<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

IEqualityOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, bool>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly struct PersistentSequencePointerReadOnly<T> : IComparable, IComparable<PersistentSequencePointerReadOnly<T>>, IComparable<NullablePointerReadOnly>, IComparable<NullablePointerUninitialized>, IComparisonOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, bool>, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IIncrementOperators<PersistentSequencePointerReadOnly<T>>, IDecrementOperators<PersistentSequencePointerReadOnly<T>>, IAdditionOperators<PersistentSequencePointerReadOnly<T>, nint, PersistentSequencePointerReadOnly<T>>, IAdditionOperators<PersistentSequencePointerReadOnly<T>, nuint, PersistentSequencePointerReadOnly<T>>, ISubtractionOperators<PersistentSequencePointerReadOnly<T>, nint, PersistentSequencePointerReadOnly<T>>, ISubtractionOperators<PersistentSequencePointerReadOnly<T>, nuint, PersistentSequencePointerReadOnly<T>>, ISubtractionOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, nint>, ITypedPointer<T, PersistentSequencePointerReadOnly<T>>, ITypedPointer<T>, IPointer<PersistentSequencePointerReadOnly<T>>, IPointer, IEquatable<PersistentSequencePointerReadOnly<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer>, IEqualityOperators<PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>, bool> where T : unmanaged

Type Parameters

Name	Description
T	The type of the target that the pointer points to.

Remarks

PersistentSequencePointerReadOnly<T> 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.
• 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.

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

Constructors

Name	Description
PersistentSequencePointerReadOnly()	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.
this[nint]	Gets a read-only reference to the target value at the specified index in the sequence the current pointer is pointing to.
this[nuint]	Gets a read-only reference to the target value at the specified index in the sequence the current pointer is pointing to.
Raw	Gets a raw pointer pointing to the same target as the current pointer.
Target	Gets a read-only reference to the target value the current pointer is pointing to.

Methods

Name	Description
AsSpan(int)	Gets a ReadOnlySpan<T> that represents a contiguous sequence of values of type T the current pointer is pointing to, having the specified length.
AsSpan(nint, int)	Gets a ReadOnlySpan<T> that represents a contiguous sequence of values of type T the current pointer is pointing to, starting at the specified start index and having the specified length.
AsSpan(nuint, int)	Gets a ReadOnlySpan<T> that represents a contiguous sequence of values of type T the current pointer is pointing to, starting at the specified start index and having the specified length.
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(PersistentSequencePointerReadOnly<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(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(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(PersistentSequencePointerReadOnly<T>)	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 PersistentSequencePointerReadOnly<T> from a memory address given as a nint.
FromRaw(T*)	Creates a PersistentSequencePointerReadOnly<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a PersistentSequencePointerReadOnly<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.

Operators

Name	Description
operator +(PersistentSequencePointerReadOnly<T>, nint)	Adds two values together to compute their sum.
operator +(PersistentSequencePointerReadOnly<T>, nuint)	Adds two values together to compute their sum.
operator +(nint, PersistentSequencePointerReadOnly<T>)	Adds two values together to compute their sum.
operator +(nuint, PersistentSequencePointerReadOnly<T>)	Adds two values together to compute their sum.
operator checked -(NullablePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator checked -(NullablePointerUninitialized<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator checked -(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator checked -(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized<T>)	Subtracts two values to compute their difference.
operator checked -(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator --(PersistentSequencePointerReadOnly<T>)	Decrements a value.
operator ==(PersistentSequencePointerReadOnly<T>, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine equality.
operator ==(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine equality.
explicit operator PersistentSequencePointerReadOnly<T>(PersistentSequencePointer)	Converts a PersistentSequencePointer to a PersistentSequencePointerReadOnly<T>.
explicit operator PersistentSequencePointerReadOnly<T>(PersistentSequencePointerReadOnly)	Converts a PersistentSequencePointerReadOnly to a PersistentSequencePointerReadOnly<T>.
explicit operator FunctionPointer(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a FunctionPointer.
explicit operator NullableFunctionPointer(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullableFunctionPointer.
explicit operator NullablePersistentFunctionPointer(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePersistentFunctionPointer.
explicit operator PersistentFunctionPointer(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PersistentFunctionPointer.
operator false(PersistentSequencePointerReadOnly<T>)	Determines whether the specified pointer is null.
operator >(NullablePointerReadOnly, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater.
operator >(NullablePointerUninitialized, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater.
operator >(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine which is greater.
operator >(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine which is greater.
operator >(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater.
operator >=(NullablePointerReadOnly, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater or equal.
operator >=(NullablePointerUninitialized, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater or equal.
operator >=(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine which is greater or equal.
operator >=(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine which is greater or equal.
operator >=(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is greater or equal.
implicit operator NullablePersistentPointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePersistentPointerReadOnly.
implicit operator NullablePersistentPointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePersistentPointerReadOnly<T>.
implicit operator NullablePersistentSequencePointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePersistentSequencePointerReadOnly.
implicit operator NullablePersistentSequencePointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePersistentSequencePointerReadOnly<T>.
implicit operator NullablePointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePointerReadOnly.
implicit operator NullablePointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullablePointerReadOnly<T>.
implicit operator NullableSequencePointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullableSequencePointerReadOnly.
implicit operator NullableSequencePointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a NullableSequencePointerReadOnly<T>.
implicit operator PersistentPointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PersistentPointerReadOnly.
implicit operator PersistentPointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PersistentPointerReadOnly<T>.
implicit operator PersistentSequencePointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PersistentSequencePointerReadOnly.
implicit operator PointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PointerReadOnly.
implicit operator PointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a PointerReadOnly<T>.
implicit operator SequencePointerReadOnly(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a SequencePointerReadOnly.
implicit operator SequencePointerReadOnly<T>(PersistentSequencePointerReadOnly<T>)	Converts a PersistentSequencePointerReadOnly<T> to a SequencePointerReadOnly<T>.
operator ++(PersistentSequencePointerReadOnly<T>)	Increments a value.
operator !=(PersistentSequencePointerReadOnly<T>, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine inequality.
operator !=(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine inequality.
operator <(NullablePointerReadOnly, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less.
operator <(NullablePointerUninitialized, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less.
operator <(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine which is less.
operator <(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine which is less.
operator <(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less.
operator <=(NullablePointerReadOnly, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less or equal.
operator <=(NullablePointerUninitialized, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less or equal.
operator <=(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly)	Compares two values to determine which is less or equal.
operator <=(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized)	Compares two values to determine which is less or equal.
operator <=(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Compares two values to determine which is less or equal.
operator -(NullablePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator -(NullablePointerUninitialized<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator -(PersistentSequencePointerReadOnly<T>, NullablePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator -(PersistentSequencePointerReadOnly<T>, NullablePointerUninitialized<T>)	Subtracts two values to compute their difference.
operator -(PersistentSequencePointerReadOnly<T>, PersistentSequencePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator -(PersistentSequencePointerReadOnly<T>, nint)	Subtracts two values to compute their difference.
operator -(PersistentSequencePointerReadOnly<T>, nuint)	Subtracts two values to compute their difference.
operator true(PersistentSequencePointerReadOnly<T>)	Determines whether the specified pointer is non-null.