ruby-zstds 1.0.5 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -42
  3. data/lib/zstds/version.rb +1 -1
  4. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2f277f0e51b0f8328d440a5f42f4834026c188f665eae60949645222cb73a23a
4
- data.tar.gz: 0d7dffc0a3a026ecc4f3d97d060b43e3e701d5f1cabc53c9694a276eccad2199
3
+ metadata.gz: 359ef05325e4af260831df1c3d71b70d64d1b4f235631ad3cd0bf10be63be308
4
+ data.tar.gz: 39b138930c23a914317db548081db091a607b00867300788d3de3c22e7e56616
5
5
  SHA512:
6
- metadata.gz: 652c9cc07c28459b47d16efa85aabb46bce2c5e35e440243aba73092ee3058e48cbcb0349179796cb041343f4c80cf2918101f6881b08b17c9922cf4dc64ce01
7
- data.tar.gz: e1b3e5fd27512a02561ad61aff70983a42ef37e86293cb75365aa39174139f37a163ac51030ef9ebec721746f6bf39114e4a8db1c851a7207bed90c2ecf092ce
6
+ metadata.gz: 0c76ce3fe240fb963dab49e55ff167a2cfea690e1bb48b107d164821d5bba1b5090eb81b73ec221a86aa4c94c05f9082d540d6c0423ae99326face5deee199d8
7
+ data.tar.gz: 00db3a70938e3ca436d253f9c2e715941837c252569bb6d72d1ddb94b1c8c9e85aeeb1bd67e9c85a0ab965c5393f785f273e67a0a3869a1ae770a915ae23ca9e
data/README.md CHANGED
@@ -103,32 +103,32 @@ end
103
103
 
104
104
  ## Options
105
105
 
106
- | Option | Values | Default | Description |
107
- |---------------------------------|------------------|--------------|-------------|
108
- | `source_buffer_length` | `0 - inf` | `0 (auto)` | internal buffer length for source data |
109
- | `destination_buffer_length` | `0 - inf` | `0 (auto)` | internal buffer length for description data |
110
- | `compression_level` | `-131072 - 22` | `0 (auto)` | compression level |
111
- | `window_log` | `10 - 31` | `0 (auto)` | maximum back-reference distance (power of 2) |
112
- | `hash_log` | `6 - 30` | `0 (auto)` | size of the initial probe table (power of 2) |
113
- | `chain_log` | `6 - 30` | `0 (auto)` | size of the multi-probe search table (power of 2) |
114
- | `search_log` | `1 - 30` | `0 (auto)` | number of search attempts (power of 2) |
115
- | `min_match` | `3 - 7` | `0 (auto)` | minimum size of searched matches |
116
- | `target_length` | `0 - 131072` | `0 (auto)` | distance between match sampling (for `:fast` strategy), length of match considered "good enough" for (for other strategies) |
117
- | `strategy` | `STRATEGIES` | `nil (auto)` | choses strategy |
118
- | `enable_long_distance_matching` | `true/false` | `nil (auto)` | enables long distance matching |
119
- | `ldm_hash_log` | `6 - 30` | `0 (auto)` | size of the table for long distance matching (power of 2) |
120
- | `ldm_min_match` | `4 - 4096` | `0 (auto)` | minimum match size for long distance matcher |
121
- | `ldm_bucket_size_log` | `1 - 8` | `0 (auto)` | log size of each bucket in the LDM hash table for collision resolution |
122
- | `ldm_hash_rate_log` | `0 - 25` | `0 (auto)` | frequency of inserting/looking up entries into the LDM hash table |
123
- | `content_size_flag` | `true/false` | `true` | enables writing of content size into frame header (if known) |
124
- | `checksum_flag` | `true/false` | `false` | enables writing of 32-bits checksum of content at end of frame |
125
- | `dict_id_flag` | `true/false` | `true` | enables writing of dictionary id into frame header |
126
- | `nb_workers` | `0 - 200` | `0 (auto)` | number of threads spawned in parallel |
127
- | `job_size` | `0 - 1073741824` | `0 (auto)` | size of job (nb_workers >= 1) |
128
- | `overlap_log` | `0 - 9` | `0 (auto)` | overlap size, as a fraction of window size |
129
- | `window_log_max` | `10 - 31` | `0 (auto)` | size limit (power of 2) |
130
- | `dictionary` | `Dictionary` | `nil` | chose dictionary |
131
- | `pledged_size` | `0 - inf` | `0 (auto)` | size of input (if known) |
106
+ | Option | Values | Default | Description |
107
+ |---------------------------------|----------------|------------|-------------|
108
+ | `source_buffer_length` | 0 - inf | 0 (auto) | internal buffer length for source data |
109
+ | `destination_buffer_length` | 0 - inf | 0 (auto) | internal buffer length for description data |
110
+ | `compression_level` | -131072 - 22 | 0 (auto) | compression level |
111
+ | `window_log` | 10 - 31 | 0 (auto) | maximum back-reference distance (power of 2) |
112
+ | `hash_log` | 6 - 30 | 0 (auto) | size of the initial probe table (power of 2) |
113
+ | `chain_log` | 6 - 30 | 0 (auto) | size of the multi-probe search table (power of 2) |
114
+ | `search_log` | 1 - 30 | 0 (auto) | number of search attempts (power of 2) |
115
+ | `min_match` | 3 - 7 | 0 (auto) | minimum size of searched matches |
116
+ | `target_length` | 0 - 131072 | 0 (auto) | distance between match sampling (for `:fast` strategy), length of match considered "good enough" for (for other strategies) |
117
+ | `strategy` | `STRATEGIES` | nil (auto) | choses strategy |
118
+ | `enable_long_distance_matching` | true/false | nil (auto) | enables long distance matching |
119
+ | `ldm_hash_log` | 6 - 30 | 0 (auto) | size of the table for long distance matching (power of 2) |
120
+ | `ldm_min_match` | 4 - 4096 | 0 (auto) | minimum match size for long distance matcher |
121
+ | `ldm_bucket_size_log` | 1 - 8 | 0 (auto) | log size of each bucket in the LDM hash table for collision resolution |
122
+ | `ldm_hash_rate_log` | 0 - 25 | 0 (auto) | frequency of inserting/looking up entries into the LDM hash table |
123
+ | `content_size_flag` | true/false | true | enables writing of content size into frame header (if known) |
124
+ | `checksum_flag` | true/false | false | enables writing of 32-bits checksum of content at end of frame |
125
+ | `dict_id_flag` | true/false | true | enables writing of dictionary id into frame header |
126
+ | `nb_workers` | 0 - 200 | 0 (auto) | number of threads spawned in parallel |
127
+ | `job_size` | 0 - 1073741824 | 0 (auto) | size of job (nb_workers >= 1) |
128
+ | `overlap_log` | 0 - 9 | 0 (auto) | overlap size, as a fraction of window size |
129
+ | `window_log_max` | 10 - 31 | 0 (auto) | size limit (power of 2) |
130
+ | `dictionary` | `Dictionary` | nil | chose dictionary |
131
+ | `pledged_size` | 0 - inf | 0 (auto) | size of input (if known) |
132
132
 
133
133
  There are internal buffers for compressed and decompressed data.
134
134
  For example you want to use 1 KB as `source_buffer_length` for compressor - please use 256 B as `destination_buffer_length`.
@@ -140,22 +140,22 @@ You can also read zstd docs for more info about options.
140
140
 
141
141
  | Option | Related constants |
142
142
  |-----------------------|-------------------|
143
- | `compression_level` | `ZSTDS::Option::MIN_COMPRESSION_LEVEL = -131072`, `ZSTDS::Option::MAX_COMPRESSION_LEVEL = 22` |
144
- | `window_log` | `ZSTDS::Option::MIN_WINDOW_LOG = 10`, `ZSTDS::Option::MAX_WINDOW_LOG = 31` |
145
- | `hash_log` | `ZSTDS::Option::MIN_HASH_LOG = 6`, `ZSTDS::Option::MAX_HASH_LOG = 30` |
146
- | `chain_log` | `ZSTDS::Option::MIN_CHAIN_LOG = 6`, `ZSTDS::Option::MAX_CHAIN_LOG = 30` |
147
- | `search_log` | `ZSTDS::Option::MIN_SEARCH_LOG = 1`, `ZSTDS::Option::MAX_SEARCH_LOG = 30` |
148
- | `min_match` | `ZSTDS::Option::MIN_MIN_MATCH = 3`, `ZSTDS::Option::MAX_MIN_MATCH = 7` |
149
- | `target_length` | `ZSTDS::Option::MIN_TARGET_LENGTH = 0`, `ZSTDS::Option::MAX_TARGET_LENGTH = 131072` |
150
- | `strategy` | `ZSTDS::Option::STRATEGIES = %i[fast dfast greedy lazy lazy2 btlazy2 btopt btultra btultra2]` |
151
- | `ldm_hash_log` | `ZSTDS::Option::MIN_LDM_HASH_LOG = 6`, `ZSTDS::Option::MAX_LDM_HASH_LOG = 30` |
152
- | `ldm_min_match` | `ZSTDS::Option::MIN_LDM_MIN_MATCH = 4`, `ZSTDS::Option::MAX_LDM_MIN_MATCH = 4096` |
153
- | `ldm_bucket_size_log` | `ZSTDS::Option::MIN_LDM_BUCKET_SIZE_LOG = 1`, `ZSTDS::Option::MAX_LDM_BUCKET_SIZE_LOG = 8` |
154
- | `ldm_hash_rate_log` | `ZSTDS::Option::MIN_LDM_HASH_RATE_LOG = 0`, `ZSTDS::Option::MAX_LDM_HASH_RATE_LOG = 25` |
155
- | `nb_workers` | `ZSTDS::Option::MIN_NB_WORKERS = 0`, `ZSTDS::Option::MAX_NB_WORKERS = 200` |
156
- | `job_size` | `ZSTDS::Option::MIN_JOB_SIZE = 0`, `ZSTDS::Option::MAX_JOB_SIZE = 1073741824` |
157
- | `overlap_log` | `ZSTDS::Option::MIN_OVERLAP_LOG = 0`, `ZSTDS::Option::MAX_OVERLAP_LOG = 9` |
158
- | `window_log_max` | `ZSTDS::Option::MIN_WINDOW_LOG_MAX = 10`, `ZSTDS::Option::MAX_WINDOW_LOG_MAX = 31` |
143
+ | `compression_level` | `ZSTDS::Option::MIN_COMPRESSION_LEVEL` = -131072, `ZSTDS::Option::MAX_COMPRESSION_LEVEL` = 22 |
144
+ | `window_log` | `ZSTDS::Option::MIN_WINDOW_LOG` = 10, `ZSTDS::Option::MAX_WINDOW_LOG` = 31 |
145
+ | `hash_log` | `ZSTDS::Option::MIN_HASH_LOG` = 6, `ZSTDS::Option::MAX_HASH_LOG` = 30 |
146
+ | `chain_log` | `ZSTDS::Option::MIN_CHAIN_LOG` = 6, `ZSTDS::Option::MAX_CHAIN_LOG` = 30 |
147
+ | `search_log` | `ZSTDS::Option::MIN_SEARCH_LOG` = 1, `ZSTDS::Option::MAX_SEARCH_LOG` = 30 |
148
+ | `min_match` | `ZSTDS::Option::MIN_MIN_MATCH` = 3, `ZSTDS::Option::MAX_MIN_MATCH` = 7 |
149
+ | `target_length` | `ZSTDS::Option::MIN_TARGET_LENGTH` = 0, `ZSTDS::Option::MAX_TARGET_LENGTH` = 131072 |
150
+ | `strategy` | `ZSTDS::Option::STRATEGIES` = `%i[fast dfast greedy lazy lazy2 btlazy2 btopt btultra btultra2]` |
151
+ | `ldm_hash_log` | `ZSTDS::Option::MIN_LDM_HASH_LOG` = 6, `ZSTDS::Option::MAX_LDM_HASH_LOG` = 30 |
152
+ | `ldm_min_match` | `ZSTDS::Option::MIN_LDM_MIN_MATCH` = 4, `ZSTDS::Option::MAX_LDM_MIN_MATCH` = 4096 |
153
+ | `ldm_bucket_size_log` | `ZSTDS::Option::MIN_LDM_BUCKET_SIZE_LOG` = 1, `ZSTDS::Option::MAX_LDM_BUCKET_SIZE_LOG` = 8 |
154
+ | `ldm_hash_rate_log` | `ZSTDS::Option::MIN_LDM_HASH_RATE_LOG` = 0, `ZSTDS::Option::MAX_LDM_HASH_RATE_LOG` = 25 |
155
+ | `nb_workers` | `ZSTDS::Option::MIN_NB_WORKERS` = 0, `ZSTDS::Option::MAX_NB_WORKERS` = 200 |
156
+ | `job_size` | `ZSTDS::Option::MIN_JOB_SIZE` = 0, `ZSTDS::Option::MAX_JOB_SIZE` = 1073741824 |
157
+ | `overlap_log` | `ZSTDS::Option::MIN_OVERLAP_LOG` = 0, `ZSTDS::Option::MAX_OVERLAP_LOG` = 9 |
158
+ | `window_log_max` | `ZSTDS::Option::MIN_WINDOW_LOG_MAX` = 10, `ZSTDS::Option::MAX_WINDOW_LOG_MAX` = 31 |
159
159
 
160
160
  Possible compressor options:
161
161
  ```
data/lib/zstds/version.rb CHANGED
@@ -2,5 +2,5 @@
2
2
  # Copyright (c) 2019 AUTHORS, MIT License.
3
3
 
4
4
  module ZSTDS
5
- VERSION = "1.0.5".freeze
5
+ VERSION = "1.0.6".freeze
6
6
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby-zstds
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.5
4
+ version: 1.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Aladjev
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-10-02 00:00:00.000000000 Z
11
+ date: 2020-10-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: codecov
@@ -194,16 +194,16 @@ require_paths:
194
194
  - lib
195
195
  required_ruby_version: !ruby/object:Gem::Requirement
196
196
  requirements:
197
- - - "~>"
197
+ - - ">="
198
198
  - !ruby/object:Gem::Version
199
- version: '2.7'
199
+ version: '2.5'
200
200
  required_rubygems_version: !ruby/object:Gem::Requirement
201
201
  requirements:
202
202
  - - ">="
203
203
  - !ruby/object:Gem::Version
204
204
  version: '0'
205
205
  requirements: []
206
- rubygems_version: 3.1.2
206
+ rubygems_version: 3.1.4
207
207
  signing_key:
208
208
  specification_version: 4
209
209
  summary: Ruby bindings for zstd library.