Skip to content

feat(grpc): add dedicated _masked query methods - #1254

Open
DaughterOfMars wants to merge 1 commit into
developfrom
feat/grpc-masked-methods
Open

feat(grpc): add dedicated _masked query methods#1254
DaughterOfMars wants to merge 1 commit into
developfrom
feat/grpc-masked-methods

Conversation

@DaughterOfMars

Copy link
Copy Markdown
Contributor

Split out of #1147. Stacked on #1253 — review/merge that one first; this PR's diff is only the _masked split.

Why

Adds ergonomic, mask-explicit variants of the gRPC query methods so callers can pass a bare field / slice / array / vec of fields without wrapping in a XxxReadMask.

What

Splits each query endpoint into two methods:

  • the plain method uses the endpoint's default read mask (its read-mask parameter is dropped), and
  • a new _masked variant takes an explicit impl Into<XxxReadMask>.

Internal callers (transaction_builder_client, examples) use the _masked variants where a custom mask is required.

Test plan

  • cargo check/clippy -Dwarnings clean for iota-sdk-grpc-client (+ tests) and iota-sdk --features grpc --examples.
  • cargo test --doc passes.

🤖 Generated with Claude Code

@DaughterOfMars
DaughterOfMars requested a review from a team as a code owner July 7, 2026 11:10
@DaughterOfMars DaughterOfMars linked an issue Jul 7, 2026 that may be closed by this pull request
@Alex6323

Copy link
Copy Markdown
Contributor

looks good except for the conflicts of course :)

@DaughterOfMars
DaughterOfMars force-pushed the feat/grpc-masked-methods branch 2 times, most recently from e9183b3 to 1cfbf88 Compare July 27, 2026 07:01
Base automatically changed from feat/grpc-typed-read-masks to develop August 4, 2026 07:07
@DaughterOfMars
DaughterOfMars force-pushed the feat/grpc-masked-methods branch from 1cfbf88 to 8c9dbd4 Compare August 4, 2026 07:24
Splits each gRPC query endpoint into two methods: the plain method uses
the endpoint's default read mask, and a new `_masked` variant takes an
explicit typed mask (`impl Into<XxxReadMask>`), so a bare field, slice,
array, or vec of fields can be passed without wrapping. The default
methods drop their read-mask parameter; internal callers use the
`_masked` variants where a custom mask is required.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

fix docs
@DaughterOfMars
DaughterOfMars force-pushed the feat/grpc-masked-methods branch from f7b3086 to 9a126b5 Compare August 7, 2026 09:42
@DaughterOfMars
DaughterOfMars requested a review from a team as a code owner August 7, 2026 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add additional grpc helper fns

2 participants