Перейти к содержимому

Топаз6.0 · До релиза

Загрузка →

Библиотека · std.bytes

Bytes.zstdCompress

Compresses this byte sequence using Zstandard and the supplied level.

zstdCompress(level: int = 3) -> Result<Bytes, string>

Модуль: std.bytes →
Получатель: Bytes
Минимальное число аргументов: 0
Максимальное число аргументов: 1

Declaration and parameters

Доступность

Включено по умолчанию · Не определено

Import std.bytes in language mode 5.21.

The current compiler selects std/bytes.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.

Получатель

Bytes

Ограничения параметров

Дополнительные контракты не определены.

Bytes.zstdCompress accepts an int level from 1 through 22. The default is 3 and other values return Err with a string.

The level is a compression effort hint. The API does not promise a size ratio, execution time, or different bytes for every pair of levels.

A successful call returns Ok with one RFC 8878 frame requiring no external dictionary. Empty input is valid.

Bytes.zstdDecompress accepts one standard frame containing raw, RLE, or compressed blocks, with valid frame parameters and an optional content checksum.

A frame requiring an unavailable dictionary, a malformed header or block, a size or checksum mismatch, and truncation return Err with a string.

Skippable frames, additional frames, and other trailing bytes return Err. The entire input must represent one data frame.

Decompression returns all uncompressed bytes in Ok or an error without a partial output. Compressing then decompressing preserves the input bytes.

The receiver and explicit level expression evaluate once in that order. The input remains unchanged and the operation performs no I/O.

Связанное правило · Use Zstandard frames and explicit effort levels →

Результат

Дополнительные контракты не определены.

The declared result type is Result<Bytes, string>.

Эффекты

Не определено

Ошибки

Не определено

Result and effects

Return one Zstandard frame in Ok. The level ranges from 1 through 22 and defaults to 3.

Resolved contracts

Use Zstandard frames and explicit effort levels

Правилоtopaz.stdlib.contract.bytes-zstd.rule

Use Zstandard frames and explicit effort levels

Bytes.zstdCompress accepts an int level from 1 through 22. The default is 3 and other values return Err with a string.

The level is a compression effort hint. The API does not promise a size ratio, execution time, or different bytes for every pair of levels.

A successful call returns Ok with one RFC 8878 frame requiring no external dictionary. Empty input is valid.

Bytes.zstdDecompress accepts one standard frame containing raw, RLE, or compressed blocks, with valid frame parameters and an optional content checksum.

A frame requiring an unavailable dictionary, a malformed header or block, a size or checksum mismatch, and truncation return Err with a string.

Skippable frames, additional frames, and other trailing bytes return Err. The entire input must represent one data frame.

Decompression returns all uncompressed bytes in Ok or an error without a partial output. Compressing then decompressing preserves the input bytes.

The receiver and explicit level expression evaluate once in that order. The input remains unchanged and the operation performs no I/O.

Причина

A bounded level range keeps calls portable. A complete frame boundary and explicit dictionary failure make the returned bytes independent of hidden decoder state.

Примеры Use the default and both supported level boundaries →Decode a valid Zstandard RLE block →Decode short nonfinal Zstandard raw blocks →Reject missing block data and trailing bytes →

Use the default and both supported level boundaries

run · running · Проверка · Не выполнялось

main.tpzUse the default and both supported level boundariesОткрыть песочницу →

import std.io
import std.test
let source = "hello".encodeUtf8()
io.writeLine(test.assertOk(test.assertOk(source.zstdCompress()).zstdDecompress()).toHex())
for level in ([1, 22]) {
io.writeLine(test.assertOk(test.assertOk(source.zstdCompress(level)).zstdDecompress()).toHex())
}
for level in ([0, 23]) {
match (source.zstdCompress(level)) {
case Err(_) => io.writeLine("invalid level")
case Ok(_) => io.writeLine("accepted")
}
}

Ожидаемый выводКод завершения 0

68656c6c6f
68656c6c6f
68656c6c6f
invalid level
invalid level

$ topaz run main.tpz · Целевой продукт 5.21.3

Ожидаемый результат

Ожидаемый результат

Выполнение завершается. Код завершения 0.

Нет вывода ошибок.

Ожидаемый стандартный вывод

68656c6c6f
68656c6c6f
68656c6c6f
invalid level
invalid level

Этот пример ещё не выполнялся.

Decode a valid Zstandard RLE block

run · running · Проверка · Не выполнялось

main.tpzDecode a valid Zstandard RLE blockОткрыть песочницу →

import std.bytes { Bytes }
import std.io
import std.test
let encoded = test.assertOk(Bytes.fromHex("28b52ffd20052b000041"))
match (encoded.zstdDecompress()) {
case Ok(bytes) => io.writeLine(bytes.toHex())
case Err(_) => io.writeLine("rejected")
}

Ожидаемый выводКод завершения 0

4141414141

$ topaz run main.tpz · Целевой продукт 5.21.3

Ожидаемый результат

Ожидаемый результат

Выполнение завершается. Код завершения 0.

Нет вывода ошибок.

Ожидаемый стандартный вывод

4141414141

Этот пример ещё не выполнялся.

Decode short nonfinal Zstandard raw blocks

run · running · Проверка · Не выполнялось

main.tpzDecode short nonfinal Zstandard raw blocksОткрыть песочницу →

import std.bytes { Bytes }
import std.io
import std.test
let encoded = test.assertOk(Bytes.fromHex("28b52ffd20020800004109000042"))
match (encoded.zstdDecompress()) {
case Ok(bytes) => io.writeLine(bytes.toHex())
case Err(_) => io.writeLine("rejected")
}

Ожидаемый выводКод завершения 0

$ topaz run main.tpz · Целевой продукт 5.21.3

Ожидаемый результат

Ожидаемый результат

Выполнение завершается. Код завершения 0.

Нет вывода ошибок.

Ожидаемый стандартный вывод

4142

Этот пример ещё не выполнялся.

Reject missing block data and trailing bytes

run · running · Проверка · Не выполнялось

main.tpzReject missing block data and trailing bytesОткрыть песочницу →

import std.bytes { Bytes }
import std.io
import std.test
for hex in (["", "28b52ffd20052900006869", "28b52ffd200001000000"]) {
match (test.assertOk(Bytes.fromHex(hex)).zstdDecompress()) {
case Err(_) => io.writeLine("invalid Zstandard")
case Ok(_) => io.writeLine("accepted")
}
}

Ожидаемый выводКод завершения 0

invalid Zstandard
invalid Zstandard
invalid Zstandard

$ topaz run main.tpz · Целевой продукт 5.21.3

Ожидаемый результат

Ожидаемый результат

Выполнение завершается. Код завершения 0.

Нет вывода ошибок.

Ожидаемый стандартный вывод

invalid Zstandard
invalid Zstandard
invalid Zstandard

Этот пример ещё не выполнялся.