Struct BlobStringText

Simple Unity.Entities.BlobString wrapper that can be embedded into components and allow to access the blob text as Unity.Collections.IUTF8Bytes and Unity.Collections.INativeList<T>. The text is considered readonly. All methods that change or affect the string will throw NotImplementedException.

Implements

INativeList<byte>

IIndexable<byte>

IUTF8Bytes

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.NetCode.LowLevel

Assembly: Unity.NetCode.dll

Syntax

public struct BlobStringText : INativeList<byte>, IIndexable<byte>, IUTF8Bytes

Constructors

BlobStringText(ref BlobString)

Construct the text from a Unity.Entities.BlobString reference. The string pointer is cached internally by this wrapper and if the original blob is detroyed, the memory content may point to something that it is not a string.

Declaration

public BlobStringText(ref BlobString blob)

Parameters

Type	Name	Description
BlobString	blob	Unity.Entities.BlobString reference.

Properties

Capacity

The number of elements that fit in the current allocation.

Declaration

public int Capacity { get; set; }

Property Value

Type	Description
int	The number of elements that fit in the current allocation.

Remarks

Always throw NotImplementedException

Exceptions

Type	Condition
NotImplementedException	Always throw NotImplementedException

IsEmpty

Whether this IUTF8Bytes is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool	True if this IUTF8Bytes is empty.

this[int]

The element at an index.

Declaration

public byte this[int index] { get; set; }

Parameters

Type	Name	Description
int	index	An index.

Property Value

Type	Description
byte	The element at the index.

Remarks

Always throw NotImplementedException

Exceptions

Type	Condition
IndexOutOfRangeException	Thrown if index is out of bounds.
NotImplementedException	Always throw NotImplementedException

Length

Declaration

public int Length { get; set; }

Property Value

Type	Description
int

Remarks

Always throw NotImplementedException

Exceptions

Type	Condition
NotImplementedException	Always throw NotImplementedException

Methods

Clear()

Sets the length to 0.

Declaration

public void Clear()

Remarks

Does not change the capacity.

Exceptions

Type	Condition
NotImplementedException	Always throw NotImplementedException

ElementAt(int)

Declaration

public ref byte ElementAt(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
byte

Remarks

Always throw NotImplementedException

Exceptions

Type	Condition
NotImplementedException	Always throw NotImplementedException

GetUnsafePtr()

Returns a pointer to the content of this IUTF8Bytes.

Declaration

public byte* GetUnsafePtr()

Returns

Type	Description
byte*	A pointer to the content of this IUTF8Bytes.

Remarks

The pointer may point to stack memory.

TryResize(int, NativeArrayOptions)

Attempt to set the length in bytes of this IUTF8Bytes's content buffer.

Declaration

public bool TryResize(int newLength, NativeArrayOptions clearOptions = NativeArrayOptions.ClearMemory)

Parameters

Type	Name	Description
int	newLength	The new length in bytes of the IUTF8Bytes's content buffer.
NativeArrayOptions	clearOptions	Whether any bytes added should be zeroed out.

Returns

Type	Description
bool	True if the new length is valid.

Remarks

Always throw NotImplementedException

Exceptions

Type	Condition
NotImplementedException	Always throw NotImplementedException

Implements

Unity.Collections.INativeList<T>

Unity.Collections.IIndexable<T>

Unity.Collections.IUTF8Bytes