Struct SequencePointer<T>

Represents a non-nullable transient pointer pointing to a contiguous sequence of targets of type T.

Implements

IComparable<SequencePointer<T>>

IComparable<NullablePointerReadOnly>

IComparable<NullablePointerUninitialized>

ITypedPointer<T, SequencePointer<T>>

ITypedPointer<T>

IPointer<SequencePointer<T>>

IPointer

ISpanFormattable

IFormattable

IUtf8SpanFormattable

IEquatable<SequencePointer<T>>

IEquatable<NullablePointerReadOnly>

IEquatable<NullablePointerUninitialized>

IEquatable<NullableFunctionPointer>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SemPtr

Assembly: SemPtr.dll

Syntax

public readonly ref struct SequencePointer<T> : IComparable<SequencePointer<T>>, IComparable<NullablePointerReadOnly>, IComparable<NullablePointerUninitialized>, ITypedPointer<T, SequencePointer<T>>, ITypedPointer<T>, IPointer<SequencePointer<T>>, IPointer, ISpanFormattable, IFormattable, IUtf8SpanFormattable, IEquatable<SequencePointer<T>>, IEquatable<NullablePointerReadOnly>, IEquatable<NullablePointerUninitialized>, IEquatable<NullableFunctionPointer> where T : unmanaged, allows ref struct

Type Parameters

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

Remarks

SequencePointer<T> has the following characteristics:

• Non-nullableYou can access the pointer's target directly without checking for null.
• 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.
• 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-writeYou can read and write the pointer's target.
• TypedThe pointer points to a contiguous sequence of targets of type T.

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

Constructors

Name	Description
SequencePointer()	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 reference to the target value at the specified index in the sequence the current pointer is pointing to.
this[nuint]	Gets a 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 reference to the target value the current pointer is pointing to.

Methods

Name	Description
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(SequencePointer<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.
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(SequencePointer<T>)	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(SequencePointer<T>) method instead.
FromIntPtr(nint)	Creates a SequencePointer<T> from a memory address given as a nint.
FromRaw(T*)	Creates a SequencePointer<T> from a raw pointer.
FromUIntPtr(nuint)	Creates a SequencePointer<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 +(SequencePointer<T>, nint)	Adds two values together to compute their sum.
operator +(SequencePointer<T>, nuint)	Adds two values together to compute their sum.
operator +(nint, SequencePointer<T>)	Adds two values together to compute their sum.
operator +(nuint, SequencePointer<T>)	Adds two values together to compute their sum.
operator checked -(NullablePointerReadOnly<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator checked -(NullablePointerUninitialized<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator checked -(SequencePointer<T>, NullablePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator checked -(SequencePointer<T>, NullablePointerUninitialized<T>)	Subtracts two values to compute their difference.
operator checked -(SequencePointer<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator --(SequencePointer<T>)	Decrements a value.
operator ==(SequencePointer<T>, NullableFunctionPointer)	Compares two values to determine equality.
operator ==(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine equality.
operator ==(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine equality.
operator ==(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine equality.
explicit operator SequencePointer<T>(PersistentSequencePointer)	Converts a PersistentSequencePointer to a SequencePointer<T>.
explicit operator SequencePointer<T>(SequencePointer)	Converts a SequencePointer to a SequencePointer<T>.
explicit operator FunctionPointer(SequencePointer<T>)	Converts a SequencePointer<T> to a FunctionPointer.
explicit operator NullableFunctionPointer(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableFunctionPointer.
operator false(SequencePointer<T>)	Determines whether the specified pointer is null.
operator >(NullablePointerReadOnly, SequencePointer<T>)	Compares two values to determine which is greater.
operator >(NullablePointerUninitialized, SequencePointer<T>)	Compares two values to determine which is greater.
operator >(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine which is greater.
operator >(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine which is greater.
operator >(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine which is greater.
operator >=(NullablePointerReadOnly, SequencePointer<T>)	Compares two values to determine which is greater or equal.
operator >=(NullablePointerUninitialized, SequencePointer<T>)	Compares two values to determine which is greater or equal.
operator >=(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine which is greater or equal.
operator >=(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine which is greater or equal.
operator >=(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine which is greater or equal.
implicit operator NullablePointer(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointer.
implicit operator NullablePointerReadOnly(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointerReadOnly.
implicit operator NullablePointerReadOnly<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointerReadOnly<T>.
implicit operator NullablePointerUninitialized(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointerUninitialized.
implicit operator NullablePointerUninitialized<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointerUninitialized<T>.
implicit operator NullablePointer<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullablePointer<T>.
implicit operator NullableSequencePointer(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointer.
implicit operator NullableSequencePointerReadOnly(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointerReadOnly.
implicit operator NullableSequencePointerReadOnly<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointerReadOnly<T>.
implicit operator NullableSequencePointerUninitialized(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointerUninitialized.
implicit operator NullableSequencePointerUninitialized<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointerUninitialized<T>.
implicit operator NullableSequencePointer<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a NullableSequencePointer<T>.
implicit operator Pointer(SequencePointer<T>)	Converts a SequencePointer<T> to a Pointer.
implicit operator PointerReadOnly(SequencePointer<T>)	Converts a SequencePointer<T> to a PointerReadOnly.
implicit operator PointerReadOnly<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a PointerReadOnly<T>.
implicit operator PointerUninitialized(SequencePointer<T>)	Converts a SequencePointer<T> to a PointerUninitialized.
implicit operator PointerUninitialized<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a PointerUninitialized<T>.
implicit operator Pointer<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a Pointer<T>.
implicit operator SequencePointer(SequencePointer<T>)	Converts a SequencePointer<T> to a SequencePointer.
implicit operator SequencePointerReadOnly(SequencePointer<T>)	Converts a SequencePointer<T> to a SequencePointerReadOnly.
implicit operator SequencePointerReadOnly<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a SequencePointerReadOnly<T>.
implicit operator SequencePointerUninitialized(SequencePointer<T>)	Converts a SequencePointer<T> to a SequencePointerUninitialized.
implicit operator SequencePointerUninitialized<T>(SequencePointer<T>)	Converts a SequencePointer<T> to a SequencePointerUninitialized<T>.
operator ++(SequencePointer<T>)	Increments a value.
operator !=(SequencePointer<T>, NullableFunctionPointer)	Compares two values to determine inequality.
operator !=(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine inequality.
operator !=(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine inequality.
operator !=(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine inequality.
operator <(NullablePointerReadOnly, SequencePointer<T>)	Compares two values to determine which is less.
operator <(NullablePointerUninitialized, SequencePointer<T>)	Compares two values to determine which is less.
operator <(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine which is less.
operator <(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine which is less.
operator <(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine which is less.
operator <=(NullablePointerReadOnly, SequencePointer<T>)	Compares two values to determine which is less or equal.
operator <=(NullablePointerUninitialized, SequencePointer<T>)	Compares two values to determine which is less or equal.
operator <=(SequencePointer<T>, NullablePointerReadOnly)	Compares two values to determine which is less or equal.
operator <=(SequencePointer<T>, NullablePointerUninitialized)	Compares two values to determine which is less or equal.
operator <=(SequencePointer<T>, SequencePointer<T>)	Compares two values to determine which is less or equal.
operator -(NullablePointerReadOnly<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator -(NullablePointerUninitialized<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator -(SequencePointer<T>, NullablePointerReadOnly<T>)	Subtracts two values to compute their difference.
operator -(SequencePointer<T>, NullablePointerUninitialized<T>)	Subtracts two values to compute their difference.
operator -(SequencePointer<T>, SequencePointer<T>)	Subtracts two values to compute their difference.
operator -(SequencePointer<T>, nint)	Subtracts two values to compute their difference.
operator -(SequencePointer<T>, nuint)	Subtracts two values to compute their difference.
operator true(SequencePointer<T>)	Determines whether the specified pointer is non-null.