Class CollectionExtensions
Inheritance
System.Object
Inherited Members
Show
Syntax
public static class CollectionExtensions
Methods
WriteSpanAndSize(NetworkWriter, Span<Byte>)
Write method for weaver to use
Declaration
public static void WriteSpanAndSize(this NetworkWriter writer, Span<byte> span)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| Span<System.Byte> | span | |
WriteSpanAndSize(NetworkWriter, Span<Byte>, Int32)
Declaration
public static void WriteSpanAndSize(this NetworkWriter writer, Span<byte> span, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| Span<System.Byte> | span | |
| System.Int32 | maxLength | |
WriteSpanAndSize(NetworkWriter, ReadOnlySpan<Byte>)
Write method for weaver to use
Declaration
public static void WriteSpanAndSize(this NetworkWriter writer, ReadOnlySpan<byte> span)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| ReadOnlySpan<System.Byte> | span | |
WriteSpanAndSize(NetworkWriter, ReadOnlySpan<Byte>, Int32)
Declaration
public static void WriteSpanAndSize(this NetworkWriter writer, ReadOnlySpan<byte> span, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| ReadOnlySpan<System.Byte> | span | |
| System.Int32 | maxLength | |
WriteBytesAndSize(NetworkWriter, Byte[], Int32, Int32)
For byte arrays with dynamic size, where the reader doesn't know how many will come
Declaration
public static void WriteBytesAndSize(this NetworkWriter writer, byte[] buffer, int offset, int count)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Byte[] | buffer | array or null |
| System.Int32 | offset | |
| System.Int32 | count | |
WriteBytesAndSize(NetworkWriter, Byte[])
Write method for weaver to use
Declaration
public static void WriteBytesAndSize(this NetworkWriter writer, byte[] buffer)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Byte[] | buffer | array or null |
WriteBytesAndSize(NetworkWriter, Byte[], Int32)
Declaration
public static void WriteBytesAndSize(this NetworkWriter writer, byte[] buffer, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Byte[] | buffer | |
| System.Int32 | maxLength | |
WriteBytesAndSizeSegment(NetworkWriter, ArraySegment<Byte>)
Declaration
public static void WriteBytesAndSizeSegment(this NetworkWriter writer, ArraySegment<byte> buffer)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.ArraySegment<System.Byte> | buffer | |
WriteBytesAndSizeSegment(NetworkWriter, ArraySegment<Byte>, Int32)
Declaration
public static void WriteBytesAndSizeSegment(this NetworkWriter writer, ArraySegment<byte> buffer, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.ArraySegment<System.Byte> | buffer | |
| System.Int32 | maxLength | |
WriteList<T>(NetworkWriter, List<T>)
Declaration
[WeaverSerializeCollection]
public static void WriteList<T>(this NetworkWriter writer, List<T> list)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Collections.Generic.List<T> | list | |
WriteList<T>(NetworkWriter, List<T>, Int32)
Declaration
[WeaverSerializeCollection]
public static void WriteList<T>(this NetworkWriter writer, List<T> list, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Collections.Generic.List<T> | list | |
| System.Int32 | maxLength | |
WriteArray<T>(NetworkWriter, T[])
Declaration
public static void WriteArray<T>(this NetworkWriter writer, T[] array)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| {T}[] | array | |
WriteArray<T>(NetworkWriter, T[], Int32)
Declaration
public static void WriteArray<T>(this NetworkWriter writer, T[] array, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| {T}[] | array | |
| System.Int32 | maxLength | |
WriteArraySegment<T>(NetworkWriter, ArraySegment<T>)
Declaration
[WeaverSerializeCollection]
public static void WriteArraySegment<T>(this NetworkWriter writer, ArraySegment<T> segment)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.ArraySegment<T> | segment | |
WriteArraySegment<T>(NetworkWriter, ArraySegment<T>, Int32)
Declaration
[WeaverSerializeCollection]
public static void WriteArraySegment<T>(this NetworkWriter writer, ArraySegment<T> segment, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.ArraySegment<T> | segment | |
| System.Int32 | maxLength | |
WriteDictionary<TKey, TValue>(NetworkWriter, Dictionary<TKey, TValue>)
Declaration
[WeaverSerializeCollection]
public static void WriteDictionary<TKey, TValue>(this NetworkWriter writer, Dictionary<TKey, TValue> dictionary)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Collections.Generic.Dictionary<TKey, TValue> | dictionary | |
WriteDictionary<TKey, TValue>(NetworkWriter, Dictionary<TKey, TValue>, Int32)
Declaration
[WeaverSerializeCollection]
public static void WriteDictionary<TKey, TValue>(this NetworkWriter writer, Dictionary<TKey, TValue> dictionary, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Collections.Generic.Dictionary<TKey, TValue> | dictionary | |
| System.Int32 | maxLength | |
WriteSpan<T>(NetworkWriter, Span<T>)
Declaration
[WeaverSerializeCollection]
public static void WriteSpan<T>(this NetworkWriter writer, Span<T> span)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| Span<T> | span | |
WriteSpan<T>(NetworkWriter, Span<T>, Int32)
Declaration
[WeaverSerializeCollection]
public static void WriteSpan<T>(this NetworkWriter writer, Span<T> span, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| Span<T> | span | |
| System.Int32 | maxLength | |
WriteReadOnlySpan<T>(NetworkWriter, ReadOnlySpan<T>)
Declaration
[WeaverSerializeCollection]
public static void WriteReadOnlySpan<T>(this NetworkWriter writer, ReadOnlySpan<T> span)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| ReadOnlySpan<T> | span | |
WriteReadOnlySpan<T>(NetworkWriter, ReadOnlySpan<T>, Int32)
Declaration
[WeaverSerializeCollection]
public static void WriteReadOnlySpan<T>(this NetworkWriter writer, ReadOnlySpan<T> span, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| ReadOnlySpan<T> | span | |
| System.Int32 | maxLength | |
ReadBytesAndSize(NetworkReader)
Declaration
public static byte[] ReadBytesAndSize(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| System.Byte[] | array or null |
ReadBytesAndSize(NetworkReader, Int32)
Declaration
public static byte[] ReadBytesAndSize(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.Byte[] | |
ReadBytesAndSizeSegment(NetworkReader)
Declaration
public static ArraySegment<byte> ReadBytesAndSizeSegment(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| System.ArraySegment<System.Byte> | |
ReadBytesAndSizeSegment(NetworkReader, Int32)
Declaration
public static ArraySegment<byte> ReadBytesAndSizeSegment(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.ArraySegment<System.Byte> | |
ReadSpanAndSize(NetworkReader)
Read method for weaver to use
Declaration
public static Span<byte> ReadSpanAndSize(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| Span<System.Byte> | |
ReadSpanAndSize(NetworkReader, Int32)
Declaration
public static Span<byte> ReadSpanAndSize(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| Span<System.Byte> | |
ReadReadOnlySpanAndSize(NetworkReader)
Read method for weaver to use
Declaration
public static ReadOnlySpan<byte> ReadReadOnlySpanAndSize(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| ReadOnlySpan<System.Byte> | |
ReadReadOnlySpanAndSize(NetworkReader, Int32)
Declaration
public static ReadOnlySpan<byte> ReadReadOnlySpanAndSize(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| ReadOnlySpan<System.Byte> | |
ReadBytes(NetworkReader, Int32)
Declaration
public static byte[] ReadBytes(this NetworkReader reader, int count)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | count | |
Returns
| Type | Description |
|---|
| System.Byte[] | |
ReadList<T>(NetworkReader)
Declaration
[WeaverSerializeCollection]
public static List<T> ReadList<T>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| System.Collections.Generic.List<T> | |
ReadList<T>(NetworkReader, Int32)
Declaration
[WeaverSerializeCollection]
public static List<T> ReadList<T>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.Collections.Generic.List<T> | |
ReadArray<T>(NetworkReader)
Declaration
public static T[] ReadArray<T>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
ReadArray<T>(NetworkReader, Int32)
Declaration
public static T[] ReadArray<T>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
ReadArraySegment<T>(NetworkReader)
Declaration
[WeaverSerializeCollection]
public static ArraySegment<T> ReadArraySegment<T>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| System.ArraySegment<T> | |
ReadArraySegment<T>(NetworkReader, Int32)
Declaration
[WeaverSerializeCollection]
public static ArraySegment<T> ReadArraySegment<T>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.ArraySegment<T> | |
ReadDictionary<TKey, TValue>(NetworkReader)
Declaration
[WeaverSerializeCollection]
public static Dictionary<TKey, TValue> ReadDictionary<TKey, TValue>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| System.Collections.Generic.Dictionary<TKey, TValue> | |
ReadDictionary<TKey, TValue>(NetworkReader, Int32)
Declaration
[WeaverSerializeCollection]
public static Dictionary<TKey, TValue> ReadDictionary<TKey, TValue>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.Collections.Generic.Dictionary<TKey, TValue> | |
ReadSpan<T>(NetworkReader)
Reads a span from the reader.
NOTE: this method allocates a new array internally to hold the data.
Declaration
[WeaverSerializeCollection]
public static Span<T> ReadSpan<T>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| Span<T> | A span pointing to a new array with the read data. |
ReadSpan<T>(NetworkReader, Int32)
Declaration
[WeaverSerializeCollection]
public static Span<T> ReadSpan<T>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
ReadReadOnlySpan<T>(NetworkReader)
Declaration
[WeaverSerializeCollection]
public static ReadOnlySpan<T> ReadReadOnlySpan<T>(this NetworkReader reader)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
Returns
| Type | Description |
|---|
| ReadOnlySpan<T> | |
ReadReadOnlySpan<T>(NetworkReader, Int32)
Declaration
[WeaverSerializeCollection]
public static ReadOnlySpan<T> ReadReadOnlySpan<T>(this NetworkReader reader, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| ReadOnlySpan<T> | |
ReadListNonAlloc<T>(NetworkReader, List<T>, out Boolean)
Reads a list from the reader into a provided list so that no new list is allocated.
This will clear the list before adding the new items.
Declaration
public static void ReadListNonAlloc<T>(this NetworkReader reader, List<T> outList, out bool wasNull)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Collections.Generic.List<T> | outList | List to be populated with data. Can not be null. |
| System.Boolean | wasNull | true if the list was null on the wire |
ReadListNonAlloc<T>(NetworkReader, List<T>, out Boolean, Int32)
Declaration
public static void ReadListNonAlloc<T>(this NetworkReader reader, List<T> outList, out bool wasNull, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Collections.Generic.List<T> | outList | |
| System.Boolean | wasNull | |
| System.Int32 | maxLength | |
ReadDictionaryNonAlloc<TKey, TValue>(NetworkReader, Dictionary<TKey, TValue>, out Boolean)
Reads a dictionary from the reader into a provided dictionary so that no new dictionary is allocated.
This will clear the dictionary before adding the new items.
Declaration
public static void ReadDictionaryNonAlloc<TKey, TValue>(this NetworkReader reader, Dictionary<TKey, TValue> outDictionary, out bool wasNull)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Collections.Generic.Dictionary<TKey, TValue> | outDictionary | |
| System.Boolean | wasNull | |
ReadDictionaryNonAlloc<TKey, TValue>(NetworkReader, Dictionary<TKey, TValue>, out Boolean, Int32)
Declaration
public static void ReadDictionaryNonAlloc<TKey, TValue>(this NetworkReader reader, Dictionary<TKey, TValue> outDictionary, out bool wasNull, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Collections.Generic.Dictionary<TKey, TValue> | outDictionary | |
| System.Boolean | wasNull | |
| System.Int32 | maxLength | |
ReadArrayNonAlloc<T>(NetworkReader, T[])
Reads an array from the reader into a provided array so that no new array is allocated.
Declaration
public static int? ReadArrayNonAlloc<T>(this NetworkReader reader, T[] outArray)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| {T}[] | outArray | Array to be populated with data. Must be large enough to hold all elements. |
Returns
| Type | Description |
|---|
| System.Nullable<System.Int32> | The number of elements read, or null if the array was null when sent |
ReadArrayNonAlloc<T>(NetworkReader, T[], Int32)
Declaration
public static int? ReadArrayNonAlloc<T>(this NetworkReader reader, T[] outArray, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| {T}[] | outArray | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.Nullable<System.Int32> | |
ReadSpanNonAlloc<T>(NetworkReader, Span<T>)
Reads a span from the reader into a provided span so that no new array is allocated.
Declaration
public static int ReadSpanNonAlloc<T>(this NetworkReader reader, Span<T> outSpan)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| Span<T> | outSpan | Span to be populated with data. Must be large enough to hold all elements. |
Returns
| Type | Description |
|---|
| System.Int32 | The number of elements read. |
ReadSpanNonAlloc<T>(NetworkReader, Span<T>, Int32)
Declaration
public static int ReadSpanNonAlloc<T>(this NetworkReader reader, Span<T> outSpan, int maxLength)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| Span<T> | outSpan | |
| System.Int32 | maxLength | |
Returns
| Type | Description |
|---|
| System.Int32 | |
WriteCountPlusOne(NetworkWriter, Nullable<Int32>)
Writes null as 0, and all over values as +1
Declaration
public static void WriteCountPlusOne(NetworkWriter writer, int? count)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkWriter | writer | |
| System.Nullable<System.Int32> | count | The real count or null if collection is is null |
ReadCountPlusOne(NetworkReader, out Int32)
Reads 0 as null, and all over values as -1
Declaration
public static bool ReadCountPlusOne(NetworkReader reader, out int count)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | count | The real count of the |
Returns
| Type | Description |
|---|
| System.Boolean | true if collection has value, false if collection is null |
ValidateSize(NetworkReader, Int32)
Use to check max size in reader before allocating array/list
Assumes each element is only 1 bit, so max size allocated will be MTU*8 if attacks tries to attack
Declaration
public static void ValidateSize(NetworkReader reader, int lengthInBits)
Parameters
| Type | Name | Description |
|---|
| Mirage.Serialization.NetworkReader | reader | |
| System.Int32 | lengthInBits | |