Allow extra keyword arguments in the Transcoding protocol #215
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 adds the ability to extend the Transcoding protocol in a non-breaking way.
This is desirable to support non-streaming codecs better. Ref: JuliaIO/CodecZstd.jl#46
To do this I added two new optional functions to the protocol:
process2
andstartproc2
.These are equivalent to their previous versions, except they can accept any keyword arguments.
These are optional to maintain compatibility with existing codecs.
This PR also sets the mode to:transcode
instead of:write
when callingstartproc
inunsafe_transcode!
This is to allow non-streaming codecs to error if they are used in a streaming context. Ref: JuliaIO/CodecZstd.jl#46
Edit: I'm removing the
:transcode
mode change because this can be a different PR.