dicts: Add option to use the *_byReference variants at creation time #60
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.
Summary
Related issue: #59
This adds two additional functions to create a
CDict
orDDict
:NewCDictByRef(dict []byte) (*CDict, error)
NewCDictLevelByRef
)NewDDictByRef(dict []byte) (*DDict, error)
My particular use-case is having hundreds (~500-2000) of dictionaries cached locally in-memory, and not wanting to potentially have three copies of each.
CDict
DDict
To mitigate the risk of the input bytes being garbage collected or moved, they get pinned and unpinned once
gozstd.CDict
andgozstd.DDict
are released. There's still risk of users mutating the input, but this is advised against in the documentation. Users of this feature implicitly accept the risks of optimization.Test Plan
I've added two types of tests:
gozstd_timing_test
benchmarksTestCompressDecompressDistinctConcurrentDictsByRef
I'm happy to add more if you think it reasonable, but I think this stresses the right things: making sure that the same underlying bytes can be used concurrently with
CDict
andDDict
.Command Output
Full Benchmark Output