guid and list serialization methods

Author: lucasteles

samples/SpaceWar.Shared/Logic/GameState.cs

@@ -49,7 +49,7 @@ public void LoadState(ref readonly BinaryBufferReader reader)
     {
         Bounds = reader.ReadRectangle();
         FrameNumber = reader.ReadInt32();
-        reader.Read(Ships);
+        reader.Read(in Ships);
     }
 
     static GameInput GetShipAI(in Ship ship) => new(

src/Backdash/Serialization/BinaryBufferReader.cs

@@ -71,12 +71,18 @@ public void ReadByte(in Span<byte> values)
         slice.CopyTo(values[..length]);
     }
 
+    /// <summary>Reads a list of <see cref="byte"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadByte(in List<byte> values) => ReadByte(GetListSpan(values));
+
     /// <summary>Reads single <see cref="sbyte"/> from buffer.</summary>
     public sbyte ReadSByte() => unchecked((sbyte)buffer[offset++]);
 
     /// <summary>Reads a span of <see cref="sbyte"/> from buffer into <paramref name="values"/>.</summary>
     public void ReadSByte(in Span<sbyte> values) => ReadSpan(values);
 
+    /// <summary>Reads a list of <see cref="sbyte"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadSByte(in List<sbyte> values) => ReadSByte(GetListSpan(values));
+
     /// <summary>Reads single <see cref="bool"/> from buffer.</summary>
     public bool ReadBoolean()
     {
@@ -88,6 +94,9 @@ public bool ReadBoolean()
     /// <summary>Reads a span of <see cref="bool"/> from buffer into <paramref name="values"/>.</summary>
     public void ReadBoolean(in Span<bool> values) => ReadSpan(values);
 
+    /// <summary>Reads a list of <see cref="bool"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadBoolean(in List<bool> values) => ReadBoolean(GetListSpan(values));
+
     /// <summary>Reads single <see cref="short"/> from buffer.</summary>
     public short ReadInt16() => ReadNumber<short>(false);
 
@@ -99,6 +108,9 @@ public void ReadInt16(in Span<short> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="short"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadInt16(in List<short> values) => ReadInt16(GetListSpan(values));
+
     /// <summary>Reads single <see cref="ushort"/> from buffer.</summary>
     public ushort ReadUInt16() => ReadNumber<ushort>(true);
 
@@ -110,6 +122,9 @@ public void ReadUInt16(in Span<ushort> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="ushort"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadUInt16(in List<ushort> values) => ReadUInt16(GetListSpan(values));
+
     /// <summary>Reads single <see cref="char"/> from buffer.</summary>
     public char ReadChar() => (char)ReadUInt16();
 
@@ -124,6 +139,9 @@ public void ReadChar(in Span<char> values)
         }
     }
 
+    /// <summary>Reads a list of <see cref="char"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadChar(in List<char> values) => ReadChar(GetListSpan(values));
+
     /// <summary>Reads single <see cref="char"/> from buffer.</summary>
     public char ReadUtf8Char()
     {
@@ -132,14 +150,17 @@ public char ReadUtf8Char()
         return result[0];
     }
 
-    /// <summary>Reads a span of <see cref="char"/> from buffer into <paramref name="values"/>.</summary>
+    /// <summary>Reads a span of UTF8 <see cref="char"/> from buffer into <paramref name="values"/>.</summary>
     public void ReadUtf8String(in Span<char> values)
     {
         var byteCount = System.Text.Encoding.UTF8.GetByteCount(values);
         System.Text.Encoding.UTF8.GetChars(CurrentBuffer[..byteCount], values);
         Advance(byteCount);
     }
 
+    /// <summary>Reads a list of UTF8 <see cref="char"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadUtf8String(in List<char> values) => ReadUtf8String(GetListSpan(values));
+
     /// <summary>Reads single <see cref="int"/> from buffer.</summary>
     public int ReadInt32() => ReadNumber<int>(false);
 
@@ -151,6 +172,9 @@ public void ReadInt32(in Span<int> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="int"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadInt32(in List<int> values) => ReadInt32(GetListSpan(values));
+
     /// <summary>Reads single <see cref="uint"/> from buffer.</summary>
     public uint ReadUInt32() => ReadNumber<uint>(true);
 
@@ -162,6 +186,9 @@ public void ReadUInt32(in Span<uint> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="uint"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadUInt32(in List<uint> values) => ReadUInt32(GetListSpan(values));
+
     /// <summary>Reads single <see cref="long"/> from buffer.</summary>
     public long ReadInt64() => ReadNumber<long>(false);
 
@@ -173,6 +200,9 @@ public void ReadInt64(in Span<long> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="long"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadInt64(in List<long> values) => ReadInt64(GetListSpan(values));
+
     /// <summary>Reads single <see cref="ulong"/> from buffer.</summary>
     public ulong ReadUInt64() => ReadNumber<ulong>(true);
 
@@ -184,6 +214,9 @@ public void ReadUInt64(in Span<ulong> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="ulong"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadUInt64(in List<ulong> values) => ReadUInt64(GetListSpan(values));
+
     /// <summary>Reads single <see cref="Int128"/> from buffer.</summary>
     public Int128 ReadInt128() => ReadNumber<Int128>(false);
 
@@ -195,6 +228,9 @@ public void ReadInt128(in Span<Int128> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="Int128"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadInt128(in List<Int128> values) => ReadInt128(GetListSpan(values));
+
     /// <summary>Reads single <see cref="UInt128"/> from buffer.</summary>
     public UInt128 ReadUInt128() => ReadNumber<UInt128>(true);
 
@@ -206,6 +242,9 @@ public void ReadUInt128(in Span<UInt128> values)
             BinaryPrimitives.ReverseEndianness(values, values);
     }
 
+    /// <summary>Reads a list of <see cref="UInt128"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadUInt128(in List<UInt128> values) => ReadUInt128(GetListSpan(values));
+
     /// <summary>Reads single <see cref="Half"/> from buffer.</summary>
     public Half ReadHalf() => BitConverter.Int16BitsToHalf(ReadInt16());
 
@@ -219,6 +258,32 @@ public void ReadUInt128(in Span<UInt128> values)
     /// <summary>Reads single <see cref="double"/> from buffer.</summary>
     public double ReadDouble() => BitConverter.Int64BitsToDouble(ReadInt64());
 
+    /// <summary>Reads single <see cref="Guid"/> from buffer.</summary>
+    public Guid ReadGuid()
+    {
+        var span = CurrentBuffer[..Unsafe.SizeOf<Guid>()];
+        var result = new Guid(span, Endianness is Endianness.BigEndian);
+        Advance(span.Length);
+        return result;
+    }
+
+    /// <summary>Reads a span of <see cref="Guid"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadGuid(in Span<Guid> values)
+    {
+        if (values.IsEmpty) return;
+        ref var current = ref MemoryMarshal.GetReference(values);
+        ref var limit = ref Unsafe.Add(ref current, values.Length);
+
+        while (Unsafe.IsAddressLessThan(ref current, ref limit))
+        {
+            current = ReadGuid();
+            current = ref Unsafe.Add(ref current, 1)!;
+        }
+    }
+
+    /// <summary>Reads a list of <see cref="Guid"/> from buffer into <paramref name="values"/>.</summary>
+    public void ReadGuid(in List<Guid> values) => ReadGuid(GetListSpan(values));
+
     /// <summary>Reads an unmanaged struct from buffer.</summary>
     public void ReadStruct<T>(ref T value) where T : unmanaged
     {
@@ -239,8 +304,11 @@ public T ReadStruct<T>() where T : unmanaged
         return result;
     }
 
+    /// <summary>Reads an unmanaged struct list from buffer.</summary>
+    public void ReadStruct<T>(in List<T> values) where T : unmanaged =>
+        ReadStruct(GetListSpan(in values));
 
-    /// <summary>Reads an unmanaged struct from buffer.</summary>
+    /// <summary>Reads an unmanaged struct span from buffer.</summary>
     public void ReadStruct<T>(in Span<T> values) where T : unmanaged =>
         ReadByte(MemoryMarshal.AsBytes(values));
 
@@ -296,15 +364,6 @@ public T ReadNumber<T>(bool isUnsigned) where T : unmanaged, IBinaryInteger<T>
         return result;
     }
 
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    Span<T> GetListSpan<T>(List<T> values)
-    {
-        var count = ReadInt32();
-        CollectionsMarshal.SetCount(values, count);
-        var span = CollectionsMarshal.AsSpan(values);
-        return span;
-    }
-
     /// <summary>Reads a <see cref="IBinarySerializable"/> <paramref name="value"/> from buffer.</summary>
     /// <typeparam name="T">A type that implements <see cref="IBinarySerializable"/>.</typeparam>
     public void Read<T>(ref T value) where T : IBinarySerializable => value.Deserialize(in this);
@@ -330,5 +389,14 @@ public void Read<T>(in Span<T> values) where T : IBinarySerializable
 
     /// <summary>Writes an array of <see cref="IBinarySerializable"/> <paramref name="values"/> into buffer.</summary>
     /// <typeparam name="T">A type that implements <see cref="IBinarySerializable"/>.</typeparam>
-    public void Read<T>(in List<T> values) where T : IBinarySerializable => Read(GetListSpan(values));
+    public void Read<T>(in List<T> values) where T : IBinarySerializable => Read(GetListSpan(in values));
+
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    Span<T> GetListSpan<T>(in List<T> values)
+    {
+        var count = ReadInt32();
+        CollectionsMarshal.SetCount(values, count);
+        var span = CollectionsMarshal.AsSpan(values);
+        return span;
+    }
 }