Commit 2d725a5
Add ClientOptions::new() and Tool::new() builder methods
Mirrors the existing MessageOptions::new() / with_* builder pattern
on the two other public #[non_exhaustive] config types that consumers
construct most often. Closes the cross-crate ergonomics gap that
#[non_exhaustive] introduces: external callers can't use struct-
literal syntax (with or without ..Default::default()) on these types,
so every field assignment becomes its own mut-let statement. The
builder shape collapses that into a single chained expression.
Caught by github-app PR #4140 review on src-tauri/src/session/cli.rs:
the mut-let-and-assign pattern read as awkward to reviewers even
after trimming to the four fields that diverge from default. Same
ergonomic friction that prompted the make_tool() helper consumers
were writing for Tool. Builder ships zero-cost convenience without
giving up #[non_exhaustive]'s SemVer protection on growable config
struct.
ClientOptions builder (rust/src/lib.rs):
- new() -> Self (documented entry point)
- with_program(impl Into<CliProgram>)
- with_prefix_args<I: IntoIterator<...>>(args)
- with_cwd(impl Into<PathBuf>)
- with_env<I: IntoIterator<(K, V)>>
- with_env_remove<I: IntoIterator<S>>
- with_extra_args<I: IntoIterator<S>>
- with_transport(Transport)
- with_github_token(impl Into<String>)
- with_use_logged_in_user(bool)
- with_log_level(LogLevel)
- with_session_idle_timeout_seconds(u64)
- with_list_models_handler<H: ListModelsHandler + 'static> (Arc-wrapped internally)
- with_session_fs(SessionFsConfig)
- with_trace_context_provider<P: TraceContextProvider + 'static> (Arc-wrapped internally)
- with_telemetry(TelemetryConfig)
Tool builder (rust/src/types.rs):
- new(impl Into<String>) -> Self (name + defaults)
- with_namespaced_name(impl Into<String>)
- with_description(impl Into<String>)
- with_instructions(impl Into<String>)
- with_parameters(serde_json::Value)
- with_overrides_built_in_tool(bool)
- with_skip_permission(bool)
Pure additive: no existing ClientOptions::default() / mut-let
patterns break, no public field visibility changes. Both builders
compose by wrapping ::default() and mutating-and-returning self,
matching MessageOptions's idiom.
Tests: client_options_builder_composes verifies all 10 chained
builder methods produce the expected internal state.
tool_builder_composes does the same for Tool's seven methods, plus
tool_with_parameters_handles_non_object_value covers the
HashMap-from-Value extraction edge case (json!(null) -> empty map
rather than panic).
CHANGELOG: new "Builder ergonomics" subsection under Documentation,
explaining the rationale and listing both builders.
Validation: 220 tests pass (was 215 + 5 new builder tests across
unit + doctest), cargo doc -D warnings clean, cargo fmt --check
clean, cargo clippy --all-features --all-targets -- -D warnings
clean.
Companion ask from github-app PR #4140 review (Sync session)
follows up: github-app's `cli.rs` and ~25 Tool::new() call sites
will switch to the builder form once this lands and the next
sync round-trip pulls it.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>1 parent e04357c commit 2d725a5
3 files changed
Lines changed: 300 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
349 | 349 | | |
350 | 350 | | |
351 | 351 | | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
352 | 374 | | |
353 | 375 | | |
354 | 376 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
571 | 571 | | |
572 | 572 | | |
573 | 573 | | |
| 574 | + | |
| 575 | + | |
| 576 | + | |
| 577 | + | |
| 578 | + | |
| 579 | + | |
| 580 | + | |
| 581 | + | |
| 582 | + | |
| 583 | + | |
| 584 | + | |
| 585 | + | |
| 586 | + | |
| 587 | + | |
| 588 | + | |
| 589 | + | |
| 590 | + | |
| 591 | + | |
| 592 | + | |
| 593 | + | |
| 594 | + | |
| 595 | + | |
| 596 | + | |
| 597 | + | |
| 598 | + | |
| 599 | + | |
| 600 | + | |
| 601 | + | |
| 602 | + | |
| 603 | + | |
| 604 | + | |
| 605 | + | |
| 606 | + | |
| 607 | + | |
| 608 | + | |
| 609 | + | |
| 610 | + | |
| 611 | + | |
| 612 | + | |
| 613 | + | |
| 614 | + | |
| 615 | + | |
| 616 | + | |
| 617 | + | |
| 618 | + | |
| 619 | + | |
| 620 | + | |
| 621 | + | |
| 622 | + | |
| 623 | + | |
| 624 | + | |
| 625 | + | |
| 626 | + | |
| 627 | + | |
| 628 | + | |
| 629 | + | |
| 630 | + | |
| 631 | + | |
| 632 | + | |
| 633 | + | |
| 634 | + | |
| 635 | + | |
| 636 | + | |
| 637 | + | |
| 638 | + | |
| 639 | + | |
| 640 | + | |
| 641 | + | |
| 642 | + | |
| 643 | + | |
| 644 | + | |
| 645 | + | |
| 646 | + | |
| 647 | + | |
| 648 | + | |
| 649 | + | |
| 650 | + | |
| 651 | + | |
| 652 | + | |
| 653 | + | |
| 654 | + | |
| 655 | + | |
| 656 | + | |
| 657 | + | |
| 658 | + | |
| 659 | + | |
| 660 | + | |
| 661 | + | |
| 662 | + | |
| 663 | + | |
| 664 | + | |
| 665 | + | |
| 666 | + | |
| 667 | + | |
| 668 | + | |
| 669 | + | |
| 670 | + | |
| 671 | + | |
| 672 | + | |
| 673 | + | |
| 674 | + | |
| 675 | + | |
| 676 | + | |
| 677 | + | |
| 678 | + | |
| 679 | + | |
| 680 | + | |
| 681 | + | |
| 682 | + | |
| 683 | + | |
| 684 | + | |
| 685 | + | |
| 686 | + | |
| 687 | + | |
| 688 | + | |
| 689 | + | |
| 690 | + | |
| 691 | + | |
| 692 | + | |
| 693 | + | |
| 694 | + | |
| 695 | + | |
| 696 | + | |
| 697 | + | |
| 698 | + | |
| 699 | + | |
| 700 | + | |
| 701 | + | |
| 702 | + | |
| 703 | + | |
| 704 | + | |
| 705 | + | |
| 706 | + | |
| 707 | + | |
| 708 | + | |
| 709 | + | |
| 710 | + | |
| 711 | + | |
| 712 | + | |
| 713 | + | |
574 | 714 | | |
575 | 715 | | |
576 | 716 | | |
| |||
1619 | 1759 | | |
1620 | 1760 | | |
1621 | 1761 | | |
| 1762 | + | |
| 1763 | + | |
| 1764 | + | |
| 1765 | + | |
| 1766 | + | |
| 1767 | + | |
| 1768 | + | |
| 1769 | + | |
| 1770 | + | |
| 1771 | + | |
| 1772 | + | |
| 1773 | + | |
| 1774 | + | |
| 1775 | + | |
| 1776 | + | |
| 1777 | + | |
| 1778 | + | |
| 1779 | + | |
| 1780 | + | |
| 1781 | + | |
| 1782 | + | |
| 1783 | + | |
| 1784 | + | |
| 1785 | + | |
| 1786 | + | |
| 1787 | + | |
| 1788 | + | |
| 1789 | + | |
| 1790 | + | |
| 1791 | + | |
| 1792 | + | |
1622 | 1793 | | |
1623 | 1794 | | |
1624 | 1795 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
333 | 333 | | |
334 | 334 | | |
335 | 335 | | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
336 | 414 | | |
337 | 415 | | |
338 | 416 | | |
| |||
2323 | 2401 | | |
2324 | 2402 | | |
2325 | 2403 | | |
2326 | | - | |
| 2404 | + | |
2327 | 2405 | | |
2328 | 2406 | | |
| 2407 | + | |
| 2408 | + | |
| 2409 | + | |
| 2410 | + | |
| 2411 | + | |
| 2412 | + | |
| 2413 | + | |
| 2414 | + | |
| 2415 | + | |
| 2416 | + | |
| 2417 | + | |
| 2418 | + | |
| 2419 | + | |
| 2420 | + | |
| 2421 | + | |
| 2422 | + | |
| 2423 | + | |
| 2424 | + | |
| 2425 | + | |
| 2426 | + | |
| 2427 | + | |
| 2428 | + | |
| 2429 | + | |
| 2430 | + | |
| 2431 | + | |
| 2432 | + | |
| 2433 | + | |
| 2434 | + | |
2329 | 2435 | | |
2330 | 2436 | | |
2331 | 2437 | | |
| |||
0 commit comments