Builder registration feature design#4
Open
MonikaKumari26 wants to merge 11 commits into
Open
Conversation
Author
darkwisebear
suggested changes
Jun 11, 2026
darkwisebear
left a comment
There was a problem hiding this comment.
This diagram serves no purpose other than duplicating information that is already (or will soon be) present in the source code. No one will understand the API by looking at this diagram, so it fails to serve it's primary purpose, which is to illustrate graphically how this API works.
To change this, we should
- Remove nitty gritty details such as small helper classes or irrelevant relations that go across 4 screens
- Split the diagram into several, with each diagram focusing on an API aspect
- (If that helps) have a high level diagram showing the most important entities of the diag API and how they interact with user software.
- Use colors to distinguish types (e.g. user-provided types vs. core library types vs utility types vs standard types)
- Assist PlantUML's layout engine by using arrows of varying length, to express how close objects shallo be rendered.
You may have a look at https://github.com/eclipse-score/communication/blob/main/score/mw/com/design/skeleton_proxy/README.md for diagrams that are exhaustive but still provide a good overview without removing too much detail.
22b1ca3 to
8a36d87
Compare
Author
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.

This PR has been created to add Builder Collection Registration pattern feature for Rust-based API design.
Additionally some updates on the README.md which includes working implementation examples that demonstrate how to use the API design in practice. The corresponding implementation can be found in the following PR:
a56dee3