Skip to content

Support stable marshaling #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Support stable marshaling #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4aae267
chore: add the Goland config to the gitignore
benjamin99 Feb 6, 2024
f482486
feat: support marshal feature with Stable flag
benjamin99 Feb 6, 2024
84df16a
chore: update the README with marshal_stable related
benjamin99 Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
bin
_vendor
.idea
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ The following features can be generated:

- `func (p *YourProto) MarshalToSizedBufferVTStrict(data []byte) (int, error)`: this function behaves like `MarshalToSizedBufferVT`, except fields are marshalled in a strict order by field's numbers they were declared in .proto file.

- `marshal_stable`: generate the following help methods

- `func (p *YourProto) MarshalVTStable() ([]byte, error)`: this function behaves like `MarshalVT`, except the maps are marshalled with the stable order to provide the deterministic results.

- `func (p *YourProto) MarshalToVTStable(data []byte) (int, error)`: this function behaves like `MarshalToVT`, except the maps are marshalled with the stable order to provide the deterministic results.

- `func (p *YourProto) MarshalToSizedBufferVTStable(data []byte) (int, error)`: this function behaves like `MarshalToSizedBufferVT`, except the maps are marshalled with the stable order to provide the deterministic results.

- `unmarshal`: generates a `func (p *YourProto) UnmarshalVT(data []byte)` that behaves similarly to calling `proto.Unmarshal(data, p)` on the message, except the unmarshalling is performed by unrolled codegen without using reflection and allocating as little memory as possible. If the receiver `p` is **not** fully zeroed-out, the unmarshal call will actually behave like `proto.Merge(data, p)`. This is because the `proto.Unmarshal` in the ProtoBuf API is implemented by resetting the destination message and then calling `proto.Merge` on it. To ensure proper `Unmarshal` semantics, ensure you've called `proto.Reset` on your message before calling `UnmarshalVT`, or that your message has been newly allocated.

Expand Down
Loading