struct-frame 0.10.5__tar.gz → 0.10.7__tar.gz

{struct_frame-0.10.5 → struct_frame-0.10.7}/AI_TESTING_GUIDE.md

@@ -42,6 +42,26 @@
 
 5. **Don't grep for `*.proto`.** Definitions live in `tests/proto/*.sf`.
 
+6. **Never delete the `ProjectReference` in `tests/csharp/StructFrameTests.csproj`.**
+   It points at `tests/generated/csharp/StructFrame.csproj` — generated,
+   gitignored, and the *only* source of the `StructFrame` namespace. If you see
+   `CS0246: The type or namespace name 'StructFrame' could not be found (are you
+   missing a using directive or an assembly reference?)`, the generated library is
+   missing; run `python test_all.py` to regenerate it. Removing the reference
+   turns one missing-library problem into ~224 CS0246 errors, and the next agent
+   adds it back — this file has oscillated for exactly this reason.
+
+7. **Don't run bare `dotnet build` on the generated C# project.** A `dotnet build`
+   run by hand starts the persistent .NET build server, which holds directory
+   handles under `tests/generated/csharp`. The next `clean()` then deletes the
+   folder's *contents* and fails to remove the folder itself (`WinError 32`),
+   aborting the run with the generated library already gone — which is what
+   produces the CS0246 storm above. `run_tests.py` now runs
+   `dotnet build-server shutdown` before cleaning and fails loudly rather than
+   continuing on a half-deleted tree, but if you build C# by hand, shut the server
+   down yourself afterwards. Omitting `-c`/`--framework` also builds every TFM in
+   `Debug`, leaving intermediates the runner did not expect.
+
 ## Quick reference
 
 ```bash

{struct_frame-0.10.5 → struct_frame-0.10.7}/CHANGELOG.md

@@ -6,9 +6,25 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
-## [0.10.5](https://github.com/mylonics/struct-frame/releases/tag/0.10.5) - 2026-08-07
+## [0.10.7](https://github.com/mylonics/struct-frame/releases/tag/0.10.7) - 2026-09-01
 
-<small>[Compare with v0.10.2](https://github.com/mylonics/struct-frame/compare/v0.10.2...0.10.5)</small>
+<small>[Compare with v0.10.6](https://github.com/mylonics/struct-frame/compare/v0.10.6...0.10.7)</small>
+
+### Fixed
+
+- Fixing ts lint issue (#368) ([77cb7a1](https://github.com/mylonics/struct-frame/commit/77cb7a1ca24475c6b043be326e7e3baac542830e) by Rijesh Augustine).
+
+## [v0.10.6](https://github.com/mylonics/struct-frame/releases/tag/v0.10.6) - 2026-08-07
+
+<small>[Compare with v0.10.5](https://github.com/mylonics/struct-frame/compare/v0.10.5...v0.10.6)</small>
+
+### Fixed
+
+- Fix csproj issue (#366) ([c77a2c8](https://github.com/mylonics/struct-frame/commit/c77a2c890783784e63e667e3930fb5bc9e90bbaa) by Rijesh Augustine).
+
+## [v0.10.5](https://github.com/mylonics/struct-frame/releases/tag/v0.10.5) - 2026-08-06
+
+<small>[Compare with v0.10.2](https://github.com/mylonics/struct-frame/compare/v0.10.2...v0.10.5)</small>
 
 ### Added
 

{struct_frame-0.10.5 → struct_frame-0.10.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: struct-frame
-Version: 0.10.5
+Version: 0.10.7
 Summary: A framework for serializing data with headers
 Project-URL: Homepage, https://github.com/mylonics/struct-frame
 Project-URL: Issues, https://github.com/mylonics/struct-frame/issues

{struct_frame-0.10.5 → struct_frame-0.10.7}/docs/src/content/docs/basic-usage/message-definitions.md

@@ -864,18 +864,20 @@ The generator enforces:
 - Envelope messages must have exactly one oneof field
 - Envelope oneof fields must be message types (not primitives/enums)
 - Envelope oneof using `msgid` discriminator must have messages with msgid
-- `extensions_start` must be ≥ 2 (at least one non-extension base field required)
-- `extensions_start` must equal an existing field number in the same scope
+- For message and oneof scopes, `extensions_start` must be ≥ 2 (at least one non-extension base field required)
+- For message and oneof scopes, `extensions_start` must equal an existing field number in the same scope
+- `extensions_start` is also accepted inside enums; enum entries with values `>= extensions_start` are excluded from the generation hash, but remain generated enum members
 - Message-level `extensions_start` cannot be combined with `oneof` fields — the wire serializes fields before oneofs, so extension fields would not be trailing. Use `option extensions_start` *inside* the `oneof` to add extension variants instead
 
 ## Wire Evolution (Extension Fields)
 
-`option extensions_start = N;` allows a message (or a `oneof` inside a message) to be extended with new fields in the future without breaking older receivers.
+`option extensions_start = N;` allows a message (or a `oneof` inside a message) to be extended with new fields in the future without breaking older receivers. It is also accepted inside enums to mark future enum values without changing the wire representation.
 
 ### How it works
 
 - Fields with number `< extensions_start` are **base fields** — always present on the wire, always covered by the magic-byte checksum seed.
 - Fields with number `>= extensions_start` are **extension fields** — newer senders include them; older receivers that received a shorter payload fill them with their [schema default](#field-default-values) on reception (zero if the field has no declared default — this is the behavior for every extension field until you add `[default = ...]` to it).
+- Enum values with number `>= extensions_start` are **extension values** — they are still emitted by every generator and still occupy the enum's normal one-byte representation. Unlike message and oneof scopes, enum scope does not require `N` to match an existing value or be at least `2`.
 - The magic bytes (CRC seed) are computed only from base fields. Adding extension fields never changes the magic bytes, so older parsers still validate the base portion correctly.
 - Extension bytes are still mixed into the full CRC *after* the magic seed, so corruption of extension data is detected.
 
@@ -967,6 +969,26 @@ message JobMessage {
 - Magic bytes are computed from base variants only.
 - The discriminator field itself is always a base field (present in every frame).
 
+### Enum-level extensions
+
+An enum can use `extensions_start` to mark values introduced by newer schema versions:
+
+```proto
+enum JobStatus {
+  option extensions_start = 3;
+
+  UNKNOWN = 0;
+  QUEUED  = 1;
+  RUNNING = 2;
+
+  // Added in a later schema version
+  COMPLETE = 3;
+  FAILED   = 4;
+}
+```
+
+This option does not add extension bytes or change enum serialization: enum fields remain one byte, and all declared values are generated. Values at or above `extensions_start` are omitted from the generation hash, so adding them does not change that hash. The enum parser accepts an integer value without requiring it to match an existing enum member or to be at least `2`.
+
 ### `BASE_SIZE` constant
 
 The generator emits a `BASE_SIZE` constant alongside `MAX_SIZE` for every message. For messages without extensions `BASE_SIZE == MAX_SIZE`. You can use `BASE_SIZE` in your application to compute how many bytes a legacy sender would transmit:

{struct_frame-0.10.5 → struct_frame-0.10.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "struct-frame"
-version = "0.10.5"
+version = "0.10.7"
 authors = [
   { name="Rijesh Augustine", email="rijesh@mylonics.com" },
 ]

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Framing/AccumulatingReader.cs

@@ -16,11 +16,17 @@ namespace StructFrame.Framing
         /// </summary>
         public enum State
         {
+            /// <summary>Reader is idle.</summary>
             Idle = 0,
+            /// <summary>Looking for the first frame start byte.</summary>
             LookingForStart1,
+            /// <summary>Looking for the second frame start byte.</summary>
             LookingForStart2,
+            /// <summary>Collecting frame header bytes.</summary>
             CollectingHeader,
+            /// <summary>Collecting frame payload bytes.</summary>
             CollectingPayload,
+            /// <summary>Parsing a complete buffer.</summary>
             BufferMode
         }
 
@@ -49,6 +55,7 @@ namespace StructFrame.Framing
         private byte _lastSeq;
         private bool _lastSeqValid;
 
+        /// <summary>Creates a reader for the supplied profile.</summary>
         public AccumulatingReader(ProfileConfig config, int bufferSize = 1024, Func<int, MessageInfo?>? getMessageInfo = null)
         {
             _config = config;
@@ -720,6 +727,7 @@ namespace StructFrame.Framing
     /// </summary>
     public class AccumulatingReader<TProfile> : AccumulatingReader where TProfile : struct, IProfileProvider
     {
+        /// <summary>Creates a reader for the compile-time profile.</summary>
         public AccumulatingReader(int bufferSize = 1024, Func<int, MessageInfo?>? getMessageInfo = null)
             : base(TProfile.Profile, bufferSize, getMessageInfo) { }
     }

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Framing/BufferParser.cs

@@ -14,6 +14,7 @@ namespace StructFrame.Framing
         private readonly ProfileConfig _config;
         private readonly Func<int, MessageInfo?>? _getMessageInfo;
 
+        /// <summary>Creates a parser for the supplied profile.</summary>
         public BufferParser(ProfileConfig config, Func<int, MessageInfo?>? getMessageInfo = null)
         {
             _config = config;
@@ -217,6 +218,7 @@ namespace StructFrame.Framing
     /// </summary>
     public class BufferParser<TProfile> : BufferParser where TProfile : struct, IProfileProvider
     {
+        /// <summary>Creates a parser for the compile-time profile.</summary>
         public BufferParser(Func<int, MessageInfo?>? getMessageInfo = null) : base(TProfile.Profile, getMessageInfo) { }
     }
 }

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Framing/BufferReader.cs

@@ -17,6 +17,7 @@ namespace StructFrame.Framing
         private int _offset;
         private int _size;
 
+        /// <summary>Creates a reader for the supplied profile.</summary>
         public BufferReader(ProfileConfig config, Func<int, MessageInfo?>? getMessageInfo = null)
         {
             _config = config;
@@ -132,6 +133,7 @@ namespace StructFrame.Framing
     /// </summary>
     public class BufferReader<TProfile> : BufferReader where TProfile : struct, IProfileProvider
     {
+        /// <summary>Creates a reader for the compile-time profile.</summary>
         public BufferReader(Func<int, MessageInfo?>? getMessageInfo = null) : base(TProfile.Profile, getMessageInfo) { }
     }
 }

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Framing/BufferWriter.cs

@@ -17,6 +17,7 @@ namespace StructFrame.Framing
         private int _offset;
         private int _capacity;
 
+        /// <summary>Creates a writer for the supplied profile.</summary>
         public BufferWriter(ProfileConfig config)
         {
             _config = config;
@@ -113,6 +114,7 @@ namespace StructFrame.Framing
     /// </summary>
     public class BufferWriter<TProfile> : BufferWriter where TProfile : struct, IProfileProvider
     {
+        /// <summary>Creates a writer for the compile-time profile.</summary>
         public BufferWriter() : base(TProfile.Profile) { }
     }
 }

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Framing/FrameEncoder.cs

@@ -13,6 +13,7 @@ namespace StructFrame.Framing
     {
         private readonly ProfileConfig _config;
 
+        /// <summary>Creates an encoder for the supplied profile.</summary>
         public FrameEncoder(ProfileConfig config)
         {
             _config = config;
@@ -236,6 +237,7 @@ namespace StructFrame.Framing
     /// </summary>
     public class FrameEncoder<TProfile> : FrameEncoder where TProfile : struct, IProfileProvider
     {
+        /// <summary>Creates an encoder for the compile-time profile.</summary>
         public FrameEncoder() : base(TProfile.Profile) { }
     }
 }

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Profiles/FrameHeaders.cs

@@ -8,11 +8,17 @@ namespace StructFrame.Profiles
     /// </summary>
     public enum HeaderType : byte
     {
+        /// <summary>No start bytes.</summary>
         None = 0,       // No start bytes
+        /// <summary>One dynamic start byte.</summary>
         Tiny = 1,       // 1 start byte [0x70+PayloadType]
+        /// <summary>Two start bytes with a dynamic payload type byte.</summary>
         Basic = 2,      // 2 start bytes [0x90] [0x70+PayloadType]
+        /// <summary>u-blox two-byte synchronization header.</summary>
         Ubx = 3,        // 2 start bytes [0xB5] [0x62]
+        /// <summary>MAVLink version 1 start byte.</summary>
         MavlinkV1 = 4,  // 1 start byte [0xFE]
+        /// <summary>MAVLink version 2 start byte.</summary>
         MavlinkV2 = 5   // 1 start byte [0xFD]
     }
 
@@ -21,12 +27,19 @@ namespace StructFrame.Profiles
     /// </summary>
     public static class HeaderConstants
     {
+        /// <summary>Basic profile start byte.</summary>
         public const byte BasicStartByte = 0x90;
+        /// <summary>Base value for dynamic payload-type start bytes.</summary>
         public const byte PayloadTypeBase = 0x70;  // Payload type encoded as 0x70 + payload_type
+        /// <summary>First u-blox synchronization byte.</summary>
         public const byte UbxSync1 = 0xB5;
+        /// <summary>Second u-blox synchronization byte.</summary>
         public const byte UbxSync2 = 0x62;
+        /// <summary>MAVLink version 1 start byte.</summary>
         public const byte MavlinkV1Stx = 0xFE;
+        /// <summary>MAVLink version 2 start byte.</summary>
         public const byte MavlinkV2Stx = 0xFD;
+        /// <summary>Maximum supported payload type value.</summary>
         public const byte MaxPayloadType = 8;
     }
 
@@ -35,12 +48,18 @@ namespace StructFrame.Profiles
     /// </summary>
     public readonly struct HeaderConfig
     {
+        /// <summary>Configured header type.</summary>
         public HeaderType HeaderType { get; }
+        /// <summary>First start byte.</summary>
         public byte StartByte1 { get; }       // First start byte (0 if none or dynamic)
+        /// <summary>Second start byte.</summary>
         public byte StartByte2 { get; }       // Second start byte (0 if none or dynamic)
+        /// <summary>Number of start bytes.</summary>
         public byte NumStartBytes { get; }    // Number of start bytes (0, 1, or 2)
+        /// <summary>Whether the start byte encodes the payload type.</summary>
         public bool EncodesPayloadType { get; } // True if start byte encodes payload type
 
+        /// <summary>Creates a header configuration.</summary>
         public HeaderConfig(HeaderType headerType, byte startByte1, byte startByte2, 
                            byte numStartBytes, bool encodesPayloadType)
         {
@@ -62,26 +81,32 @@ namespace StructFrame.Profiles
     /// </summary>
     public static class HeaderConfigs
     {
+        /// <summary>Header configuration without start bytes.</summary>
         public static readonly HeaderConfig None = new HeaderConfig(
             HeaderType.None, 0, 0, 0, false
         );
 
+        /// <summary>Header configuration with one dynamic start byte.</summary>
         public static readonly HeaderConfig Tiny = new HeaderConfig(
             HeaderType.Tiny, 0, 0, 1, true  // dynamic - 0x70 + payload_type
         );
 
+        /// <summary>Header configuration with two start bytes.</summary>
         public static readonly HeaderConfig Basic = new HeaderConfig(
             HeaderType.Basic, HeaderConstants.BasicStartByte, 0, 2, true
         );
 
+        /// <summary>u-blox header configuration.</summary>
         public static readonly HeaderConfig Ubx = new HeaderConfig(
             HeaderType.Ubx, HeaderConstants.UbxSync1, HeaderConstants.UbxSync2, 2, false
         );
 
+        /// <summary>MAVLink version 1 header configuration.</summary>
         public static readonly HeaderConfig MavlinkV1 = new HeaderConfig(
             HeaderType.MavlinkV1, HeaderConstants.MavlinkV1Stx, 0, 1, false
         );
 
+        /// <summary>MAVLink version 2 header configuration.</summary>
         public static readonly HeaderConfig MavlinkV2 = new HeaderConfig(
             HeaderType.MavlinkV2, HeaderConstants.MavlinkV2Stx, 0, 1, false
         );

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Profiles/PayloadTypes.cs

@@ -8,14 +8,23 @@ namespace StructFrame.Profiles
     /// </summary>
     public enum PayloadType : byte
     {
+        /// <summary>Minimal payload without length or checksum.</summary>
         Minimal = 0,                      // [MSG_ID] [PACKET]
+        /// <summary>Default payload with one-byte length.</summary>
         Default = 1,                      // [LEN] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with extended message IDs.</summary>
         ExtendedMsgIds = 2,               // [LEN] [PKG_ID] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with a two-byte length.</summary>
         ExtendedLength = 3,               // [LEN16] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with extended length and message IDs.</summary>
         Extended = 4,                     // [LEN16] [PKG_ID] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with system and component IDs.</summary>
         SysComp = 5,                      // [SYS_ID] [COMP_ID] [LEN] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with a sequence number.</summary>
         Seq = 6,                          // [SEQ] [LEN] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Payload with sequence, system, and component IDs.</summary>
         MultiSystemStream = 7,            // [SEQ] [SYS_ID] [COMP_ID] [LEN] [MSG_ID] [PACKET] [CRC1] [CRC2]
+        /// <summary>Extended payload with sequence, system, and component IDs.</summary>
         ExtendedMultiSystemStream = 8     // [SEQ] [SYS_ID] [COMP_ID] [LEN16] [PKG_ID] [MSG_ID] [PACKET] [CRC1] [CRC2]
     }
 
@@ -24,16 +33,26 @@ namespace StructFrame.Profiles
     /// </summary>
     public readonly struct PayloadConfig
     {
+        /// <summary>Configured payload type.</summary>
         public PayloadType PayloadType { get; }
+        /// <summary>Whether the payload has a checksum.</summary>
         public bool HasCrc { get; }
+        /// <summary>Checksum size in bytes.</summary>
         public byte CrcBytes { get; }      // 0 or 2
+        /// <summary>Whether the payload has a length field.</summary>
         public bool HasLength { get; }
+        /// <summary>Length field size in bytes.</summary>
         public byte LengthBytes { get; }   // 0, 1, or 2
+        /// <summary>Whether the payload has a sequence number.</summary>
         public bool HasSeq { get; }
+        /// <summary>Whether the payload has a system ID.</summary>
         public bool HasSysId { get; }
+        /// <summary>Whether the payload has a component ID.</summary>
         public bool HasCompId { get; }
+        /// <summary>Whether the payload has a package ID.</summary>
         public bool HasPkgId { get; }
 
+        /// <summary>Creates a payload configuration.</summary>
         public PayloadConfig(PayloadType payloadType, bool hasCrc, byte crcBytes,
                             bool hasLength, byte lengthBytes, bool hasSeq,
                             bool hasSysId, bool hasCompId, bool hasPkgId)
@@ -95,6 +114,7 @@ namespace StructFrame.Profiles
     /// </summary>
     public static class PayloadConfigs
     {
+        /// <summary>Minimal payload configuration.</summary>
         public static readonly PayloadConfig Minimal = new PayloadConfig(
             PayloadType.Minimal,
             false, 0,   // no CRC
@@ -105,6 +125,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Default payload configuration.</summary>
         public static readonly PayloadConfig Default = new PayloadConfig(
             PayloadType.Default,
             true, 2,    // has CRC, 2 bytes
@@ -115,6 +136,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Extended message ID payload configuration.</summary>
         public static readonly PayloadConfig ExtendedMsgIds = new PayloadConfig(
             PayloadType.ExtendedMsgIds,
             true, 2,    // has CRC, 2 bytes
@@ -125,6 +147,7 @@ namespace StructFrame.Profiles
             true        // has pkg_id
         );
 
+        /// <summary>Extended length payload configuration.</summary>
         public static readonly PayloadConfig ExtendedLength = new PayloadConfig(
             PayloadType.ExtendedLength,
             true, 2,    // has CRC, 2 bytes
@@ -135,6 +158,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Extended payload configuration.</summary>
         public static readonly PayloadConfig Extended = new PayloadConfig(
             PayloadType.Extended,
             true, 2,    // has CRC, 2 bytes
@@ -145,6 +169,7 @@ namespace StructFrame.Profiles
             true        // has pkg_id
         );
 
+        /// <summary>System/component payload configuration.</summary>
         public static readonly PayloadConfig SysComp = new PayloadConfig(
             PayloadType.SysComp,
             true, 2,    // has CRC, 2 bytes
@@ -155,6 +180,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Sequence-number payload configuration.</summary>
         public static readonly PayloadConfig Seq = new PayloadConfig(
             PayloadType.Seq,
             true, 2,    // has CRC, 2 bytes
@@ -165,6 +191,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Multi-system stream payload configuration.</summary>
         public static readonly PayloadConfig MultiSystemStream = new PayloadConfig(
             PayloadType.MultiSystemStream,
             true, 2,    // has CRC, 2 bytes
@@ -175,6 +202,7 @@ namespace StructFrame.Profiles
             false       // no pkg_id
         );
 
+        /// <summary>Extended multi-system stream payload configuration.</summary>
         public static readonly PayloadConfig ExtendedMultiSystemStream = new PayloadConfig(
             PayloadType.ExtendedMultiSystemStream,
             true, 2,    // has CRC, 2 bytes

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Profiles/ProfileConfig.cs

@@ -7,8 +7,11 @@ namespace StructFrame.Profiles
     /// </summary>
     public class ProfileConfig
     {
+        /// <summary>Profile name.</summary>
         public string Name { get; }
+        /// <summary>Frame header configuration.</summary>
         public HeaderConfig Header { get; }
+        /// <summary>Payload configuration.</summary>
         public PayloadConfig Payload { get; }
 
         // Cached computed values for performance
@@ -16,20 +19,33 @@ namespace StructFrame.Profiles
         private readonly byte _computedStartByte2;
 
         // Computed properties
+        /// <summary>Number of frame start bytes.</summary>
         public byte NumStartBytes => Header.NumStartBytes;
+        /// <summary>Whether the profile includes a length field.</summary>
         public bool HasLength => Payload.HasLength;
+        /// <summary>Length field size in bytes.</summary>
         public byte LengthBytes => Payload.LengthBytes;
+        /// <summary>Whether the profile includes a checksum.</summary>
         public bool HasCrc => Payload.HasCrc;
+        /// <summary>Whether the profile includes a package ID.</summary>
         public bool HasPkgId => Payload.HasPkgId;
+        /// <summary>Whether the profile includes a sequence number.</summary>
         public bool HasSeq => Payload.HasSeq;
+        /// <summary>Whether the profile includes a system ID.</summary>
         public bool HasSysId => Payload.HasSysId;
+        /// <summary>Whether the profile includes a component ID.</summary>
         public bool HasCompId => Payload.HasCompId;
 
+        /// <summary>Total header size including start bytes.</summary>
         public int HeaderSize => Header.NumStartBytes + Payload.HeaderSize;
+        /// <summary>Footer size in bytes.</summary>
         public int FooterSize => Payload.FooterSize;
+        /// <summary>Total framing overhead in bytes.</summary>
         public int Overhead => HeaderSize + FooterSize;
+        /// <summary>Maximum payload size allowed by the profile.</summary>
         public int MaxPayload => Payload.MaxPayload;
 
+        /// <summary>Creates a profile configuration.</summary>
         public ProfileConfig(string name, HeaderConfig header, PayloadConfig payload)
         {
             Name = name;

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Profiles/ProfileProviders.cs

@@ -15,31 +15,42 @@ namespace StructFrame.Profiles
     /// </summary>
     public interface IProfileProvider
     {
+        /// <summary>Gets the profile configuration.</summary>
         static abstract ProfileConfig Profile { get; }
     }
 
+    /// <summary>Compile-time provider for the standard profile.</summary>
     public struct StandardProfile : IProfileProvider
     {
+        /// <summary>Gets the standard profile.</summary>
         public static ProfileConfig Profile => Profiles.Standard;
     }
 
+    /// <summary>Compile-time provider for the sensor profile.</summary>
     public struct SensorProfile : IProfileProvider
     {
+        /// <summary>Gets the sensor profile.</summary>
         public static ProfileConfig Profile => Profiles.Sensor;
     }
 
+    /// <summary>Compile-time provider for the IPC profile.</summary>
     public struct IPCProfile : IProfileProvider
     {
+        /// <summary>Gets the IPC profile.</summary>
         public static ProfileConfig Profile => Profiles.IPC;
     }
 
+    /// <summary>Compile-time provider for the bulk profile.</summary>
     public struct BulkProfile : IProfileProvider
     {
+        /// <summary>Gets the bulk profile.</summary>
         public static ProfileConfig Profile => Profiles.Bulk;
     }
 
+    /// <summary>Compile-time provider for the network profile.</summary>
     public struct NetworkProfile : IProfileProvider
     {
+        /// <summary>Gets the network profile.</summary>
         public static ProfileConfig Profile => Profiles.Network;
     }
 

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Sdk/StructFrameSdk.cs

@@ -195,6 +195,7 @@ namespace StructFrame.Sdk
         /// </summary>
         public event EventHandler? ConnectionClosed;
 
+        /// <summary>Creates an SDK client with the supplied configuration.</summary>
         public StructFrameSdk(StructFrameSdkConfig config)
         {
             _transport = config.Transport;
@@ -485,8 +486,10 @@ namespace StructFrame.Sdk
         }
 
         // Keep old names as thin wrappers so existing tests compile without changes.
+        /// <summary>Re-encode and send a parsed frame using the configured profile.</summary>
         [Obsolete("Use ReencodeAsync")]
         public Task<SendResult> Send(FrameMsgInfo frame) => ReencodeAsync(frame);
+        /// <summary>Forward an already-framed message without re-encoding.</summary>
         [Obsolete("Use ForwardAsync")]
         public Task<SendResult> SendDirect(FrameMsgInfo frame) => ForwardAsync(frame);
 

{struct_frame-0.10.5 → struct_frame-0.10.7}/src/struct_frame/boilerplate/csharp/Framework/Sdk/Transport.cs

@@ -14,8 +14,11 @@ namespace StructFrame.Sdk
     /// </summary>
     public class TransportConfig
     {
+        /// <summary>Whether to reconnect automatically after a failure.</summary>
         public bool AutoReconnect { get; set; } = false;
+        /// <summary>Delay between reconnect attempts in milliseconds.</summary>
         public int ReconnectDelayMs { get; set; } = 1000;
+        /// <summary>Maximum reconnect attempts; zero means unlimited.</summary>
         public int MaxReconnectAttempts { get; set; } = 0; // 0 = infinite
     }
 
@@ -24,10 +27,14 @@ namespace StructFrame.Sdk
     /// </summary>
     public readonly struct SendResult
     {
+        /// <summary>Whether the send completed successfully.</summary>
         public bool Success { get; }
+        /// <summary>Number of bytes attempted.</summary>
         public int AttemptedBytes { get; }
+        /// <summary>Number of bytes written.</summary>
         public int BytesWritten { get; }
 
+        /// <summary>Creates a send result.</summary>
         public SendResult(bool success, int attemptedBytes, int bytesWritten)
         {
             Success = success;
@@ -107,26 +114,37 @@ namespace StructFrame.Sdk
     public abstract class BaseTransport : ITransport, IBufferReceiveTransport, IDisposable
     {
         // Volatile: written on connect/disconnect paths and read from receive threads.
+        /// <summary>Connection state shared across transport threads.</summary>
         protected volatile bool _connected;
+        /// <summary>Transport reconnect configuration.</summary>
         protected TransportConfig _config;
+        /// <summary>Number of reconnect attempts made.</summary>
         protected int _reconnectAttempts;
         private readonly SemaphoreSlim _sendSemaphore = new SemaphoreSlim(1, 1);
         private int _reconnectInProgress;
         private bool _disposed;
 
+        /// <summary>Raised when byte-array data is received.</summary>
         public event EventHandler<byte[]>? DataReceived;
+        /// <summary>Raised when memory data is received.</summary>
         public event EventHandler<ReadOnlyMemory<byte>>? DataReceivedMemory;
+        /// <summary>Raised when a transport error occurs.</summary>
         public event EventHandler<Exception>? ErrorOccurred;
+        /// <summary>Raised when the connection closes.</summary>
         public event EventHandler? ConnectionClosed;
 
+        /// <summary>Gets whether the transport is connected.</summary>
         public bool IsConnected => _connected;
 
+        /// <summary>Creates a base transport with optional configuration.</summary>
         protected BaseTransport(TransportConfig? config = null)
         {
             _config = config ?? new TransportConfig();
         }
 
+        /// <summary>Connects to the transport endpoint.</summary>
         public abstract Task ConnectAsync();
+        /// <summary>Disconnects from the transport endpoint.</summary>
         public abstract Task DisconnectAsync();
 
         /// <summary>
@@ -190,12 +208,14 @@ namespace StructFrame.Sdk
         protected virtual Task<int> SendCoreAsync(byte[] data)
             => throw new NotImplementedException("Override SendCoreAsync(ReadOnlyMemory<byte>) or SendCoreAsync(byte[])");
 
+        /// <summary>Raises data-received events for a byte array.</summary>
         protected void OnDataReceived(byte[] data)
         {
             DataReceivedMemory?.Invoke(this, data);
             DataReceived?.Invoke(this, data);
         }
 
+        /// <summary>Raises data-received events for a memory slice.</summary>
         protected void OnDataReceived(ReadOnlyMemory<byte> data)
         {
             DataReceivedMemory?.Invoke(this, data);
@@ -208,6 +228,7 @@ namespace StructFrame.Sdk
         private static byte[] ToByteArrayForLegacyEvent(ReadOnlyMemory<byte> data)
             => data.ToArray();
 
+        /// <summary>Raises an error event and starts reconnect handling when enabled.</summary>
         protected void OnErrorOccurred(Exception error)
         {
             ErrorOccurred?.Invoke(this, error);
@@ -217,6 +238,7 @@ namespace StructFrame.Sdk
             }
         }
 
+        /// <summary>Raises the connection-closed event and starts reconnect handling when enabled.</summary>
         protected void OnConnectionClosed()
         {
             _connected = false;