Add simple zstd EncodeTo/DecodeTo functions #1079

klauspost · 2025-06-02T14:59:14Z

Requires Go 1.24, since it uses weak pointers.

// EncodeTo appends the encoded data from src to dst.
func EncodeTo(dst []byte, src []byte) []byte

// DecodeTo appends the decoded data from src to dst.
// The maximum decoded size is 1GiB,
// not including what may already be in dst.
func DecodeTo(dst []byte, src []byte) ([]byte, error)

Summary by CodeRabbit

New Features
- Introduced simplified global functions for Zstandard compression and decompression, offering efficient encoding and decoding with optimized concurrency and memory usage for Go 1.24 and above.

Requires Go 1.24, since it uses weak pointers. ``` // EncodeTo appends the encoded data from src to dst. func EncodeTo(dst []byte, src []byte) []byte // DecodeTo appends the decoded data from src to dst. // The maximum decoded size is 1GiB, // not including what may already be in dst. func DecodeTo(dst []byte, src []byte) ([]byte, error) ```

coderabbitai · 2025-06-02T14:59:21Z

📝 Walkthrough

Walkthrough

A new Go file, simple_go124.go, has been added to the zstd package, introducing simplified global functions for Zstandard compression and decompression. The file implements thread-safe, lazily-initialized, shared encoder and decoder instances with concurrency and memory optimizations, targeting Go 1.24 and above.

Changes

File(s)	Change Summary
zstd/simple_go124.go	Added new file with global `EncodeTo` and `DecodeTo` functions, shared encoder/decoder logic, and concurrency/memory optimizations.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ZstdPkg
    participant Encoder
    participant Decoder

    Caller->>ZstdPkg: EncodeTo(dst, src)
    ZstdPkg->>Encoder: (Lazily initialize if nil)
    Encoder-->>ZstdPkg: Compress src to dst
    ZstdPkg-->>Caller: Return compressed data

    Caller->>ZstdPkg: DecodeTo(dst, src)
    ZstdPkg->>Decoder: (Lazily initialize if nil)
    Decoder-->>ZstdPkg: Decompress src to dst
    ZstdPkg-->>Caller: Return decompressed data or error

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33f59b4 and afc8523.

📒 Files selected for processing (1)

zstd/simple_go124.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (16)

GitHub Check: build (1.22.x, ubuntu-latest)
GitHub Check: fuzz-s2 (nounsafe)
GitHub Check: fuzz-s2 ("noasm,nounsafe")
GitHub Check: fuzz-other ("noasm,nounsafe")
GitHub Check: fuzz-other (nounsafe)
GitHub Check: fuzz-zstd ("noasm,nounsafe")
GitHub Check: fuzz-zstd (nounsafe)
GitHub Check: build (1.24.x, macos-latest)
GitHub Check: build (1.24.x, windows-latest)
GitHub Check: build (1.23.x, macos-latest)
GitHub Check: build-special
GitHub Check: build (1.23.x, ubuntu-latest)
GitHub Check: build (1.23.x, windows-latest)
GitHub Check: build (1.24.x, ubuntu-latest)
GitHub Check: build (1.22.x, windows-latest)
GitHub Check: build (1.22.x, macos-latest)

🔇 Additional comments (3)

zstd/simple_go124.go (3)

1-6: LGTM! Build constraint and package declaration are correct.

The build constraint properly targets Go 1.24+ which is required for weak pointer support.

8-13: LGTM! All imports are necessary and properly used.

The imports cover all required functionality: error handling, runtime info, synchronization, and weak pointers.

15-17: LGTM! Global variable design is appropriate.

Using weak pointers for shared instances allows garbage collection when unused while providing performance benefits through reuse. The mutex properly protects concurrent access.

zstd/simple_go124.go

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [github.com/klauspost/compress](https://github.com/klauspost/compress) | `v1.18.0` -> `v1.18.1` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fklauspost%2fcompress/v1.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fklauspost%2fcompress/v1.18.0/v1.18.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>klauspost/compress (github.com/klauspost/compress)</summary> ### [`v1.18.1`](https://github.com/klauspost/compress/releases/tag/v1.18.1) [Compare Source](klauspost/compress@v1.18.0...v1.18.1) #### What's Changed - zstd: Fix incorrect buffer size in dictionary encodes by [@klauspost](https://github.com/klauspost) in [#1059](klauspost/compress#1059) - s2: check for cap, not len of buffer in EncodeBetter/Best by [@vdarulis](https://github.com/vdarulis) in [#1080](klauspost/compress#1080) - zstd: Add simple zstd EncodeTo/DecodeTo functions by [@klauspost](https://github.com/klauspost) in [#1079](klauspost/compress#1079) - zlib: Avoiding extra allocation in zlib.reader.Reset by [@travelpolicy](https://github.com/travelpolicy) in [#1086](klauspost/compress#1086) - gzhttp: remove redundant err check in zstdReader by [@ryanfowler](https://github.com/ryanfowler) in [#1090](klauspost/compress#1090) - Run modernize. Deprecate Go 1.22 by [@klauspost](https://github.com/klauspost) in [#1095](klauspost/compress#1095) - flate: Simplify matchlen by [@klauspost](https://github.com/klauspost) in [#1101](klauspost/compress#1101) - flate: Add examples by [@klauspost](https://github.com/klauspost) in [#1102](klauspost/compress#1102) - flate: Use exact sizes for huffman tables by [@klauspost](https://github.com/klauspost) in [#1103](klauspost/compress#1103) - flate: Faster load+store by [@klauspost](https://github.com/klauspost) in [#1104](klauspost/compress#1104) - Add notice to S2 about MinLZ by [@klauspost](https://github.com/klauspost) in [#1065](klauspost/compress#1065) #### New Contributors - [@wooffie](https://github.com/wooffie) made their first contribution in [#1069](klauspost/compress#1069) - [@vdarulis](https://github.com/vdarulis) made their first contribution in [#1080](klauspost/compress#1080) - [@travelpolicy](https://github.com/travelpolicy) made their first contribution in [#1086](klauspost/compress#1086) - [@ryanfowler](https://github.com/ryanfowler) made their first contribution in [#1090](klauspost/compress#1090) **Full Changelog**: <klauspost/compress@v1.18.0...v1.18.1> </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9786 Reviewed-by: Earl Warren <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

coderabbitai bot reviewed Jun 2, 2025

View reviewed changes

zstd/simple_go124.go Show resolved Hide resolved

zstd/simple_go124.go Show resolved Hide resolved

klauspost merged commit 0b8a32c into master Jun 17, 2025
22 checks passed

klauspost deleted the zstd-simple-use branch June 17, 2025 13:52

coderabbitai bot mentioned this pull request Jul 2, 2025

Fix simple encoder src/dst swapped #1083

Merged

m90 mentioned this pull request Oct 21, 2025

Bump github.com/klauspost/compress from 1.18.0 to 1.18.1 offen/docker-volume-backup#656

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add simple zstd EncodeTo/DecodeTo functions #1079

Add simple zstd EncodeTo/DecodeTo functions #1079

klauspost commented Jun 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 2, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add simple zstd EncodeTo/DecodeTo functions #1079

Add simple zstd EncodeTo/DecodeTo functions #1079

Conversation

klauspost commented Jun 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

klauspost commented Jun 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)