Skip to content

Fix incorrect sample code in README (DDict usage and CDict example) #141

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.

Sign up for GitHub

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

Open
Watson1978 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix incorrect sample code in README (DDict usage and CDict example) #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ res << stream.finish

#### Streaming Compression with CDict of level 5
```ruby
cdict = Zstd::CDict.new(File.read('dictionary_file', 5)
cdict = Zstd::CDict.new(File.read('dictionary_file'), 5)
stream = Zstd::StreamingCompress.new(dict: cdict)
stream << "abc" << "def"
res = stream.flush
Expand All @@ -143,8 +143,8 @@ Zstd.decompress(compressed_using_dict, dict: File.read('dictionary_file'))
If you use the same dictionary repeatedly, you can speed up the setup by creating DDict in advance:

```ruby
ddict = Zstd::Ddict.new(File.read('dictionary_file'))
data = Zstd.compress(compressed_using_dict, ddict)
ddict = Zstd::DDict.new(File.read('dictionary_file'))
data = Zstd.decompress(compressed_using_dict, dict: ddict)
```

#### Streaming Decompression
Expand Down