docs(hydro_lang): explain embedded serialization mode in networking docs#3043
Merged
Merged
Conversation
Deploying hydro with
|
| Latest commit: |
961b3ec
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://58f43854.hydroflow.pages.dev |
| Branch Preview URL: | https://sandbox-da498c15-aae9-4182-b.hydroflow.pages.dev |
shadaj
marked this pull request as ready for review
July 17, 2026 21:52
shadaj
added a commit
that referenced
this pull request
Jul 17, 2026
Confirmed that UDP channels support `.embedded()` serialization (verified via a throwaway codegen test: `UDP.lossy_delayed_forever().embedded()` generates `FnMut(T)` sinks / `Stream<Item = T>` sources just like TCP, since the embedded backend ignores the transport info during codegen — the declared transport is a contract the hand-wired transport must uphold). - `docs/docs/hydro/reference/locations/network-configuration.md`: replace the "bincode is the only supported backend" claim with a new "Embedded" subsection under Serialization, explaining raw-element channels, the transport-as-contract semantics (including UDP), the absence of a transport `Result` on the receive side, and backend availability (embedded deployments + simulator only; panics on Hydro Deploy/Maelstrom) - `docs/docs/hydro/reference/deploy/embedded.mdx`: update the Networking intro to mention both serialization modes, and add an "Embedded Serialization" section showing the generated struct signatures for `.embedded()` channels (untagged and tagged), fault-handling ownership, and cross-links to the network configuration page Doc snippets verified via the `include_mdtests` doctests in `hydro_test`. Co-authored-by: Infinity 🤖 <infinity@hydro.run> PR: #3043
shadaj
force-pushed
the
sandbox-da498c15-aae9-4182-b653-c6ce3211da67
branch
from
July 17, 2026 22:13
ce80f97 to
5219915
Compare
akainth015
reviewed
Jul 17, 2026
akainth015
left a comment
akainth015
left a comment
Member
There was a problem hiding this comment.
One question, but it looks great overall
MingweiSamuel
approved these changes
Jul 20, 2026
Confirmed that UDP channels support `.embedded()` serialization (verified via a throwaway codegen test: `UDP.lossy_delayed_forever().embedded()` generates `FnMut(T)` sinks / `Stream<Item = T>` sources just like TCP, since the embedded backend ignores the transport info during codegen — the declared transport is a contract the hand-wired transport must uphold). - `docs/docs/hydro/reference/locations/network-configuration.md`: replace the "bincode is the only supported backend" claim with a new "Embedded" subsection under Serialization, explaining raw-element channels, the transport-as-contract semantics (including UDP), the absence of a transport `Result` on the receive side, and backend availability (embedded deployments + simulator only; panics on Hydro Deploy/Maelstrom) - `docs/docs/hydro/reference/deploy/embedded.mdx`: update the Networking intro to mention both serialization modes, and add an "Embedded Serialization" section showing the generated struct signatures for `.embedded()` channels (untagged and tagged), fault-handling ownership, and cross-links to the network configuration page Doc snippets verified via the `include_mdtests` doctests in `hydro_test`. Co-authored-by: Infinity 🤖 <infinity@hydro.run> PR: #3043
shadaj
force-pushed
the
sandbox-da498c15-aae9-4182-b653-c6ce3211da67
branch
from
July 20, 2026 22:29
5219915 to
961b3ec
Compare
shadaj
enabled auto-merge (squash)
July 20, 2026 22:33
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Confirmed that UDP channels support
.embedded()serialization (verifiedvia a throwaway codegen test:
UDP.lossy_delayed_forever().embedded()generates
FnMut(T)sinks /Stream<Item = T>sources just like TCP,since the embedded backend ignores the transport info during codegen —
the declared transport is a contract the hand-wired transport must uphold).
docs/docs/hydro/reference/locations/network-configuration.md: replacethe "bincode is the only supported backend" claim with a new "Embedded"
subsection under Serialization, explaining raw-element channels, the
transport-as-contract semantics (including UDP), the absence of a
transport
Resulton the receive side, and backend availability(embedded deployments + simulator only; panics on Hydro Deploy/Maelstrom)
docs/docs/hydro/reference/deploy/embedded.mdx: update the Networkingintro to mention both serialization modes, and add an "Embedded
Serialization" section showing the generated struct signatures for
.embedded()channels (untagged and tagged), fault-handling ownership,and cross-links to the network configuration page
Doc snippets verified via the
include_mdtestsdoctests inhydro_test.