Use stack-based records/structs instead of heap-based records/classes (#128)

VirxEC · web-flow · commit b0cccb461720 · 2025-07-15T08:36:08.000+02:00
* Use stack-allocated records/structs instead of heap-allocated records/classes

* Version bump

* Bridge v0.7.11
diff --git a/RLBotCS/Server/BridgeHandler.cs b/RLBotCS/Server/BridgeHandler.cs
@@ -130,7 +130,10 @@ private async Task HandleServer()
                     continue;
                 }
 
-                if (_context.GameState.MatchEnded)
+                if (
+                    _context.GameState.MatchPhase == MatchPhase.Ended
+                    || _context.GameState.MatchPhase == MatchPhase.Inactive
+                )
                 {
                     // reset everything
                     _context.QuickChat.ClearChats();
diff --git a/RLBotCS/Server/BridgeMessage/AddPerfSample.cs b/RLBotCS/Server/BridgeMessage/AddPerfSample.cs
@@ -1,6 +1,6 @@
 ﻿namespace RLBotCS.Server.BridgeMessage;
 
-record AddPerfSample(uint Index, bool GotInput) : IBridgeMessage
+readonly struct AddPerfSample(uint Index, bool GotInput) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/AddRenders.cs b/RLBotCS/Server/BridgeMessage/AddRenders.cs
@@ -2,7 +2,7 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record AddRenders(int ClientId, int RenderId, List<RenderMessageT> RenderItems)
+readonly struct AddRenders(int ClientId, int RenderId, List<RenderMessageT> RenderItems)
     : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
diff --git a/RLBotCS/Server/BridgeMessage/AgentReservationRequest.cs b/RLBotCS/Server/BridgeMessage/AgentReservationRequest.cs
@@ -4,7 +4,7 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record AgentReservationRequest(
+readonly struct AgentReservationRequest(
     int ClientId,
     ChannelWriter<SessionMessage> SessionWriter,
     string AgentId
diff --git a/RLBotCS/Server/BridgeMessage/ClearRenders.cs b/RLBotCS/Server/BridgeMessage/ClearRenders.cs
@@ -1,6 +1,6 @@
 ﻿namespace RLBotCS.Server.BridgeMessage;
 
-record ClearRenders() : IBridgeMessage
+readonly struct ClearRenders() : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/EndMatch.cs b/RLBotCS/Server/BridgeMessage/EndMatch.cs
@@ -1,6 +1,6 @@
 namespace RLBotCS.Server.BridgeMessage;
 
-record EndMatch() : IBridgeMessage
+readonly struct EndMatch() : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/Input.cs b/RLBotCS/Server/BridgeMessage/Input.cs
@@ -5,7 +5,7 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record Input(PlayerInputT PlayerInput) : IBridgeMessage
+readonly struct Input(PlayerInputT PlayerInput) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/RemoveClientRenders.cs b/RLBotCS/Server/BridgeMessage/RemoveClientRenders.cs
@@ -1,6 +1,6 @@
 ﻿namespace RLBotCS.Server.BridgeMessage;
 
-record RemoveClientRenders(int ClientId) : IBridgeMessage
+readonly struct RemoveClientRenders(int ClientId) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context) =>
         context.RenderingMgmt.ClearClientRenders(ClientId);
diff --git a/RLBotCS/Server/BridgeMessage/RemoveRenders.cs b/RLBotCS/Server/BridgeMessage/RemoveRenders.cs
@@ -1,6 +1,6 @@
 ﻿namespace RLBotCS.Server.BridgeMessage;
 
-record RemoveRenders(int ClientId, int RenderId) : IBridgeMessage
+readonly struct RemoveRenders(int ClientId, int RenderId) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context) =>
         context.RenderingMgmt.RemoveRenderGroup(ClientId, RenderId);
diff --git a/RLBotCS/Server/BridgeMessage/SessionReady.cs b/RLBotCS/Server/BridgeMessage/SessionReady.cs
@@ -1,6 +1,6 @@
 namespace RLBotCS.Server.BridgeMessage;
 
-record SessionReady(int ClientId) : IBridgeMessage
+readonly struct SessionReady(int ClientId) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/SetGameState.cs b/RLBotCS/Server/BridgeMessage/SetGameState.cs
@@ -3,7 +3,7 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record SetGameState(DesiredGameStateT GameState) : IBridgeMessage
+readonly struct SetGameState(DesiredGameStateT GameState) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/SetInitLoadout.cs b/RLBotCS/Server/BridgeMessage/SetInitLoadout.cs
@@ -7,7 +7,7 @@ namespace RLBotCS.Server.BridgeMessage;
 /// Sets the loadout of a bot that has yet to ready up and spawn (replaces loadout generators from v4).
 /// See also <see cref="StateSetLoadout"/> for loadout change during matches.
 /// </summary>
-record SetInitLoadout(PlayerLoadoutT Loadout, int PlayerId) : IBridgeMessage
+readonly struct SetInitLoadout(PlayerLoadoutT Loadout, int PlayerId) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
@@ -28,7 +28,8 @@ public void HandleMessage(BridgeContext context)
             return;
         }
 
-        var player = matchConfig.PlayerConfigurations.Find(p => p.PlayerId == PlayerId);
+        int thisPlayerId = PlayerId;
+        var player = matchConfig.PlayerConfigurations.Find(p => p.PlayerId == thisPlayerId);
         if (player is null)
         {
             context.Logger.LogError(
diff --git a/RLBotCS/Server/BridgeMessage/ShowQuickChat.cs b/RLBotCS/Server/BridgeMessage/ShowQuickChat.cs
@@ -2,7 +2,7 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record ShowQuickChat(MatchCommT MatchComm) : IBridgeMessage
+readonly struct ShowQuickChat(MatchCommT MatchComm) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/StartMatch.cs b/RLBotCS/Server/BridgeMessage/StartMatch.cs
@@ -9,7 +9,7 @@ namespace RLBotCS.Server.BridgeMessage;
 /// not from <see cref="FlatBuffersSession"/>, as the <see cref="FlatBuffersServer"/>
 /// needs to be reset too to avoid distributing old match configs.
 /// </summary>
-record StartMatch(MatchConfigurationT MatchConfig) : IBridgeMessage
+readonly struct StartMatch(MatchConfigurationT MatchConfig) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
diff --git a/RLBotCS/Server/BridgeMessage/StateSetLoadout.cs b/RLBotCS/Server/BridgeMessage/StateSetLoadout.cs
@@ -7,13 +7,14 @@
 
 namespace RLBotCS.Server.BridgeMessage;
 
-record StateSetLoadout(PlayerLoadoutT Loadout, uint Index) : IBridgeMessage
+readonly struct StateSetLoadout(PlayerLoadoutT Loadout, uint Index) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context)
     {
+        uint thisIndex = Index;
         PlayerMetadata? meta = context
             .GameState.PlayerMapping.GetKnownPlayers()
-            .FirstOrDefault(kp => Index == kp.PlayerIndex);
+            .FirstOrDefault(kp => thisIndex == kp.PlayerIndex);
         if (meta == null)
             return;
 
@@ -47,6 +48,7 @@ public void HandleMessage(BridgeContext context)
             {
                 CommandId = commandId,
                 PlayerId = meta.PlayerId,
+                AgentId = meta.AgentId,
                 DesiredPlayerIndex = meta.PlayerIndex,
                 IsCustomBot = true,
                 IsBot = true,
diff --git a/RLBotCS/Server/BridgeMessage/UnreserveAgents.cs b/RLBotCS/Server/BridgeMessage/UnreserveAgents.cs
@@ -1,6 +1,6 @@
 ﻿namespace RLBotCS.Server.BridgeMessage;
 
-record UnreserveAgents(int clientId) : IBridgeMessage
+readonly struct UnreserveAgents(int clientId) : IBridgeMessage
 {
     public void HandleMessage(BridgeContext context) =>
         context.AgentMapping.UnreserveAgents(clientId);
diff --git a/RLBotCS/Server/FlatBuffersSession.cs b/RLBotCS/Server/FlatBuffersSession.cs
@@ -13,27 +13,29 @@ namespace RLBotCS.Server;
 /// <summary>
 /// A message sent to <see cref="FlatBuffersSession"/> from <see cref="FlatBuffersServer"/>.
 /// </summary>
-record SessionMessage
+interface SessionMessage
 {
-    public record MatchConfig(MatchConfigurationT Config) : SessionMessage;
+    public readonly record struct MatchConfig(MatchConfigurationT Config) : SessionMessage;
 
-    public record FieldInfo(FieldInfoT Info) : SessionMessage;
+    public readonly record struct FieldInfo(FieldInfoT Info) : SessionMessage;
 
-    public record PlayerIdPairs(uint Team, List<PlayerIdPair> IdMaps) : SessionMessage;
+    public readonly record struct PlayerIdPairs(uint Team, List<PlayerIdPair> IdMaps)
+        : SessionMessage;
 
-    public record DistributeBallPrediction(BallPredictionT BallPrediction) : SessionMessage;
+    public readonly record struct DistributeBallPrediction(BallPredictionT BallPrediction)
+        : SessionMessage;
 
-    public record DistributeGameState(GamePacketT GameState) : SessionMessage;
+    public readonly record struct DistributeGameState(GamePacketT GameState) : SessionMessage;
 
-    public record RendersAllowed(bool Allowed) : SessionMessage;
+    public readonly record struct RendersAllowed(bool Allowed) : SessionMessage;
 
-    public record StateSettingAllowed(bool Allowed) : SessionMessage;
+    public readonly record struct StateSettingAllowed(bool Allowed) : SessionMessage;
 
-    public record MatchComm(MatchCommT Message) : SessionMessage;
+    public readonly record struct MatchComm(MatchCommT Message) : SessionMessage;
 
-    public record StopMatch(bool Force) : SessionMessage;
+    public readonly record struct StopMatch(bool Force) : SessionMessage;
 
-    public record UpdateRendering(RenderingStatus Status) : SessionMessage;
+    public readonly record struct UpdateRendering(RenderingStatus Status) : SessionMessage;
 }
 
 class FlatBuffersSession
diff --git a/RLBotCS/Server/ServerMessage/DistributeFieldInfo.cs b/RLBotCS/Server/ServerMessage/DistributeFieldInfo.cs
@@ -4,7 +4,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record DistributeFieldInfo(GameState GameState) : IServerMessage
+readonly struct DistributeFieldInfo(GameState GameState) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/Server/ServerMessage/DistributeGamePacket.cs b/RLBotCS/Server/ServerMessage/DistributeGamePacket.cs
@@ -3,7 +3,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record DistributeGamePacket(GamePacketT Packet) : IServerMessage
+readonly struct DistributeGamePacket(GamePacketT Packet) : IServerMessage
 {
     private static void DistributeBallPrediction(ServerContext context, GamePacketT packet)
     {
diff --git a/RLBotCS/Server/ServerMessage/IntroDataRequest.cs b/RLBotCS/Server/ServerMessage/IntroDataRequest.cs
@@ -6,7 +6,7 @@ namespace RLBotCS.Server.ServerMessage;
 /// <summary>
 /// Fetch match config, field info, and relevant bot indexes for a client.
 /// </summary>
-record IntroDataRequest(
+readonly struct IntroDataRequest(
     int ClientId,
     ChannelWriter<SessionMessage> SessionWriter,
     string AgentId
diff --git a/RLBotCS/Server/ServerMessage/SendMatchComm.cs b/RLBotCS/Server/ServerMessage/SendMatchComm.cs
@@ -3,7 +3,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record SendMatchComm(int ClientId, MatchCommT MatchComm) : IServerMessage
+readonly struct SendMatchComm(int ClientId, MatchCommT MatchComm) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/Server/ServerMessage/SessionClosed.cs b/RLBotCS/Server/ServerMessage/SessionClosed.cs
@@ -2,7 +2,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record SessionClosed(int ClientId) : IServerMessage
+readonly struct SessionClosed(int ClientId) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/Server/ServerMessage/StartMatch.cs b/RLBotCS/Server/ServerMessage/StartMatch.cs
@@ -5,7 +5,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record StartMatch(MatchConfigurationT MatchConfig) : IServerMessage
+readonly struct StartMatch(MatchConfigurationT MatchConfig) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/Server/ServerMessage/StopMatch.cs b/RLBotCS/Server/ServerMessage/StopMatch.cs
@@ -2,7 +2,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record StopMatch(bool ShutdownServer) : IServerMessage
+readonly struct StopMatch(bool ShutdownServer) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/Server/ServerMessage/UpdateRendering.cs b/RLBotCS/Server/ServerMessage/UpdateRendering.cs
@@ -2,7 +2,7 @@
 
 namespace RLBotCS.Server.ServerMessage;
 
-record UpdateRendering(RenderingStatus Status) : IServerMessage
+readonly struct UpdateRendering(RenderingStatus Status) : IServerMessage
 {
     public ServerAction Execute(ServerContext context)
     {
diff --git a/RLBotCS/lib/Bridge.dll b/RLBotCS/lib/Bridge.dll

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,10 @@ private async Task HandleServer()`
`130`	`130`	`continue;`
`131`	`131`	`}`
`132`	`132`
`133`		`- if (_context.GameState.MatchEnded)`
	`133`	`+ if (`
	`134`	`+ _context.GameState.MatchPhase == MatchPhase.Ended`
	`135`	`+ \|\| _context.GameState.MatchPhase == MatchPhase.Inactive`
	`136`	`+ )`
`134`	`137`	`{`
`135`	`138`	`// reset everything`
`136`	`139`	`_context.QuickChat.ClearChats();`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record AddPerfSample(uint Index, bool GotInput) : IBridgeMessage`
	`3`	`+readonly struct AddPerfSample(uint Index, bool GotInput) : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context)`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace RLBotCS.Server.BridgeMessage;`
`4`	`4`
`5`		`-record AddRenders(int ClientId, int RenderId, List<RenderMessageT> RenderItems)`
	`5`	`+readonly struct AddRenders(int ClientId, int RenderId, List<RenderMessageT> RenderItems)`
`6`	`6`	`: IBridgeMessage`
`7`	`7`	`{`
`8`	`8`	`public void HandleMessage(BridgeContext context)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record ClearRenders() : IBridgeMessage`
	`3`	`+readonly struct ClearRenders() : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context)`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record EndMatch() : IBridgeMessage`
	`3`	`+readonly struct EndMatch() : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context)`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace RLBotCS.Server.BridgeMessage;`
`7`	`7`
`8`		`-record Input(PlayerInputT PlayerInput) : IBridgeMessage`
	`8`	`+readonly struct Input(PlayerInputT PlayerInput) : IBridgeMessage`
`9`	`9`	`{`
`10`	`10`	`public void HandleMessage(BridgeContext context)`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record RemoveClientRenders(int ClientId) : IBridgeMessage`
	`3`	`+readonly struct RemoveClientRenders(int ClientId) : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context) =>`
`6`	`6`	`context.RenderingMgmt.ClearClientRenders(ClientId);`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record RemoveRenders(int ClientId, int RenderId) : IBridgeMessage`
	`3`	`+readonly struct RemoveRenders(int ClientId, int RenderId) : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context) =>`
`6`	`6`	`context.RenderingMgmt.RemoveRenderGroup(ClientId, RenderId);`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace RLBotCS.Server.BridgeMessage;`
`2`	`2`
`3`		`-record SessionReady(int ClientId) : IBridgeMessage`
	`3`	`+readonly struct SessionReady(int ClientId) : IBridgeMessage`
`4`	`4`	`{`
`5`	`5`	`public void HandleMessage(BridgeContext context)`
`6`	`6`	`{`