docs: update README usage section with serialize sample and blittable structs by google-labs-jules[bot] · Pull Request #89 · sator-imaging/ZeroSerializer

google-labs-jules · 2026-08-20T22:06:17Z

Added serialize code sample to the existing code block in the Usage section of README.md and introduced a dedicated 'Blittable Structs' subsection outlining their benefits and usage.

PR created automatically by Jules for task 17471951661693468938 started by @sator-imaging

google-labs-jules · 2026-08-20T22:06:18Z

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

For security, I will only act on instructions from the user who triggered this task.

sator-imaging · 2026-08-20T22:37:33Z

+Blittable structs provide significant benefits:
+- **No Offset Table**: Serialized directly as raw memory payloads without field offset overhead.
+- **Instant Materialization**: Convert a View directly back to the original struct using the `.Materialize()` extension method.
+- **Maximum Performance**: Fast direct memory copy operations with zero deserialization overhead.


Suggested change

- **Maximum Performance**: Fast direct memory copy operations with zero deserialization overhead.

- **Maximum Performance**: Fast direct memory copy operations with zero serialization/deserialization overhead.

Applied suggestion to emphasize zero serialization/deserialization overhead.

sator-imaging · 2026-08-20T22:38:24Z

+
+Blittable structs provide significant benefits:
+- **No Offset Table**: Serialized directly as raw memory payloads without field offset overhead.
+- **Instant Materialization**: Convert a View directly back to the original struct using the `.Materialize()` extension method.


Suggested change

- **Instant Materialization**: Convert a View directly back to the original struct using the `.Materialize()` extension method.

Applied suggestion to remove redundant materialization bullet point.

sator-imaging · 2026-08-20T22:39:26Z

+
+// Serializing a blittable struct (exact fixed byte size available via RequiredByteLength)
+var transform = new Transform { PositionX = 1.0f, PositionY = 2.0f, PositionZ = 3.0f };
+var buffer = new byte[TransformView.RequiredByteLength];


Suggested change

var buffer = new byte[TransformView.RequiredByteLength];

var buffer = new byte[TransformView.RequiredByteLength]; // 12 bytes

Applied suggestion to add '// 12 bytes' comment to byte array allocation.

sator-imaging · 2026-08-20T22:52:04Z

+
+// Serializing data into a buffer using generated 'Serialize' extension method.
+var packet = new Packet { Id = 1, Name = "John", Values = new[] { 10, 20 } };
+var buffer = new byte[256];


Suggested change

var buffer = new byte[256];

Span<byte> buffer = stackalloc byte[256];

Applied suggestion to use stackalloc byte buffer for serialization.

sator-imaging · 2026-08-20T22:55:26Z

+Structs marked with both `[ZeroSerializer]` and `[StructLayout(LayoutKind.Sequential, Pack = 1)]` are recognized as blittable structs.
+
+Blittable structs provide significant benefits:
+- **No Offset Table**: Serialized directly as raw memory payloads without field offset overhead.


Suggested change

- **No Offset Table**: Serialized directly as raw memory payloads without field offset overhead.

- **No Offset Table**: Serialized directly as raw memory payloads without field offset table.

Applied suggestion to update wording to 'field offset table'.

sator-imaging · 2026-08-20T22:56:12Z

+
+Blittable structs provide significant benefits:
+- **No Offset Table**: Serialized directly as raw memory payloads without field offset overhead.
+- **Maximum Performance**: Fast direct memory copy operations with zero serialization/deserialization overhead.


Suggested change

- **Maximum Performance**: Fast direct memory copy operations with zero serialization/deserialization overhead.

- **Maximum Performance**: Fast direct memory copy operations with zero overhead.

Applied suggestion to simplify maximum performance description.

sator-imaging · 2026-08-21T04:49:55Z

@@ -58,6 +63,35 @@ ReadOnlyMemory<byte> retainedData = packetView;
 ```


Suggested change

```

Removed implicit conversion section as suggested.

sator-imaging · 2026-08-21T04:50:16Z

+int writtenBytes = packet.Serialize(buffer);
 ```

 View construction does not read every property. Values are decoded directly from the original memory only on access.


Suggested change

View construction does not read every property. Values are decoded directly from the original memory only on access.

> [!TIP]

> View construction does not read every property. Values are decoded directly from the original memory only on access.

Formatted view construction note as a GitHub [!TIP] callout.

docs: update README with serialize sample and blittable struct section

a613f3c

github-actions Bot added the documentation Improvements or additions to documentation label Aug 20, 2026

sator-imaging reviewed Aug 20, 2026

View reviewed changes

docs: address PR comments in README.md

e3dfff4

sator-imaging reviewed Aug 20, 2026

View reviewed changes

docs: address additional PR review feedback on README.md

9fbda9c

sator-imaging reviewed Aug 21, 2026

View reviewed changes

docs: update README with TIP callout and remove redundant section

b1d1b88

	- Maximum Performance: Fast direct memory copy operations with zero deserialization overhead.
	- Maximum Performance: Fast direct memory copy operations with zero serialization/deserialization overhead.

	var buffer = new byte[TransformView.RequiredByteLength];
	var buffer = new byte[TransformView.RequiredByteLength]; // 12 bytes

	var buffer = new byte[256];
	Span<byte> buffer = stackalloc byte[256];

	- No Offset Table: Serialized directly as raw memory payloads without field offset overhead.
	- No Offset Table: Serialized directly as raw memory payloads without field offset table.

		@@ -58,6 +63,35 @@ ReadOnlyMemory<byte> retainedData = packetView;
		```

	View construction does not read every property. Values are decoded directly from the original memory only on access.
	> [!TIP]
	> View construction does not read every property. Values are decoded directly from the original memory only on access.

Conversation

google-labs-jules Bot commented Aug 20, 2026

Uh oh!

google-labs-jules Bot commented Aug 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 21, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-labs-jules Bot Aug 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant