Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that Builders cannot be re-used? #111

Open
FrancisRussell opened this issue Nov 7, 2018 · 3 comments
Open

Document that Builders cannot be re-used? #111

FrancisRussell opened this issue Nov 7, 2018 · 3 comments

Comments

@FrancisRussell
Copy link

@FrancisRussell FrancisRussell commented Nov 7, 2018

From the documentation, it's unclear if Builders can be re-used. The presence of init_root() gives the impression that a Builder can be re-initialized for construction of a new message. Given that one wishes to avoid repeated memory allocations, this seems like an obvious thing to do, but attempting to do so results in increasingly larger messages (presumably all the previous messages concatenated, but I've not checked this in depth).

@dwrensha
Copy link
Member

@dwrensha dwrensha commented Nov 8, 2018

Yep, the init_ methods clear out the old data, but don't reclaim the old space. More documentation about this would be good.

@FrancisRussell
Copy link
Author

@FrancisRussell FrancisRussell commented Nov 8, 2018

Does this mean, as appeared to be the case, that a Builder cannot be re-used? If so, is this behaviour deliberate?

@dwrensha
Copy link
Member

@dwrensha dwrensha commented Nov 8, 2018

You can reuse a message::Builder, but the usefulness of doing so is limited because you will continue to accumulate unused memory that can only be reclaimed by dropping the message::Builder.

The best way to avoid allocations between messages is to use message::ScratchSpaceHeapAllocator. That allows you to specify a buffer that will be used for the first segment of your message and can be reused between messages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants