Make client construction typesafe - #336
Open
itsibitzi wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Introduces typestate-based client construction to prevent mixing HTTP and direct-only methods.
Changes:
- Adds
HttpandDirectbuilder modes. - Moves mode-specific methods into specialized implementations.
- Adds compile-fail documentation examples.
Show a summary per file
| File | Description |
|---|---|
crates/twirp/src/client.rs |
Implements type-safe HTTP and direct client builders. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Medium
| /// twirp::ClientBuilder::new(url) | ||
| /// .with_default_header("x-request-id", HeaderValue::from_static("example")); | ||
| /// ``` | ||
| pub struct ClientBuilder<T = Http> { |
itsibitzi
force-pushed
the
itsibitzi/20260715-typesafe-client-construction
branch
from
July 15, 2026 10:56
59f09d8 to
7ccda90
Compare
tclem
approved these changes
Jul 15, 2026
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
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.
Use zero size types to make it impossible to mix direct and HTTP client functions during construction. Previously this was a panic.
This shouldn't change any code when a client is just calling the
direct()function, but return types and parameter types will need to be updated if folks are passing around a builder.