S2 Public API
s2c(name, cpu, index, mode, out, snappy, src)
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| name | A unique name for this target. | Name | required | |
| cpu | Amount of threads | Integer | optional | 4 |
| index | Add seek index | Boolean | optional | True |
| mode | Either ‘faster’ or ‘slower’ | String | optional | “slower” |
| out | Name of the compressed file | Label | required | |
| snappy | Generate Snappy compatible output | Boolean | optional | False |
| src | Source file to compress | Label | required |
S2FileInfo(output, input, is_self_extractable)
S2 File Provider
FIELDS
| Name | Description |
|---|---|
| output | Compressed file |
| input | Input file |
| is_self_extractable | Whether or not the output is self-extractable |
s2_compress(name, out, kwargs)
Macro around s2c rule
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| name | Name of the target | none |
| out | Name of the output file | None |
| kwargs | All other args of s2c | none |