mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2025-12-16 19:23:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

std.compress.zstandard: clean up streaming API

Browse Source
This commit is contained in:
dweiller 2023-02-21 14:31:02 +11:00
parent c7c35bf9e6
commit c6ef83efe5
1 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
lib/std/compress/zstandard.zig
View File

@ -8,10 +8,14 @@ pub const compressed_block = types.compressed_block;
pub const decompress = @import("zstandard/decompress.zig"); pub const decompress = @import("zstandard/decompress.zig");
pub const DecompressStreamOptions = struct {
verify_checksum: bool = true,
window_size_max: usize = 1 << 23, // 8MiB default maximum window size,
};
pub fn DecompressStream( pub fn DecompressStream(
comptime ReaderType: type, comptime ReaderType: type,
comptime verify_checksum: bool, comptime options: DecompressStreamOptions,
comptime window_size_max: usize,
) type { ) type {
return struct { return struct {
const Self = @This(); const Self = @This();
@ -27,7 +31,7 @@ pub fn DecompressStream(
offset_fse_buffer: []types.compressed_block.Table.Fse, offset_fse_buffer: []types.compressed_block.Table.Fse,
literals_buffer: []u8, literals_buffer: []u8,
sequence_buffer: []u8, sequence_buffer: []u8,
checksum: if (verify_checksum) ?u32 else void, checksum: if (options.verify_checksum) ?u32 else void,
current_frame_decompressed_size: usize, current_frame_decompressed_size: usize,
pub const Error = ReaderType.Error || error{ pub const Error = ReaderType.Error || error{
@ -69,8 +73,8 @@ pub fn DecompressStream(
const frame_context = context: { const frame_context = context: {
break :context try decompress.FrameContext.init( break :context try decompress.FrameContext.init(
header, header,
window_size_max, options.window_size_max,
verify_checksum, options.verify_checksum,
); );
}; };
@ -99,10 +103,10 @@ pub fn DecompressStream(
); );
const buffer = try RingBuffer.init(self.allocator, frame_context.window_size); const buffer = try RingBuffer.init(self.allocator, frame_context.window_size);
const literals_data = try self.allocator.alloc(u8, window_size_max); const literals_data = try self.allocator.alloc(u8, options.window_size_max);
errdefer self.allocator.free(literals_data); errdefer self.allocator.free(literals_data);
const sequence_data = try self.allocator.alloc(u8, window_size_max); const sequence_data = try self.allocator.alloc(u8, options.window_size_max);
errdefer self.allocator.free(sequence_data); errdefer self.allocator.free(sequence_data);
self.literal_fse_buffer = literal_fse_buffer; self.literal_fse_buffer = literal_fse_buffer;
@ -116,7 +120,7 @@ pub fn DecompressStream(
self.decode_state = decode_state; self.decode_state = decode_state;
self.frame_context = frame_context; self.frame_context = frame_context;
self.checksum = if (verify_checksum) null else {}; self.checksum = if (options.verify_checksum) null else {};
self.current_frame_decompressed_size = 0; self.current_frame_decompressed_size = 0;
self.state = .InFrame; self.state = .InFrame;
@ -199,7 +203,7 @@ pub fn DecompressStream(
if (self.frame_context.has_checksum) { if (self.frame_context.has_checksum) {
const checksum = source_reader.readIntLittle(u32) catch const checksum = source_reader.readIntLittle(u32) catch
return error.MalformedFrame; return error.MalformedFrame;
if (comptime verify_checksum) { if (comptime options.verify_checksum) {
if (self.frame_context.hasher_opt) |*hasher| { if (self.frame_context.hasher_opt) |*hasher| {
if (checksum != decompress.computeChecksum(hasher)) if (checksum != decompress.computeChecksum(hasher))
return error.ChecksumFailure; return error.ChecksumFailure;
@ -232,17 +236,24 @@ pub fn DecompressStream(
}; };
} }
pub fn decompressStreamOptions(
allocator: Allocator,
reader: anytype,
comptime options: DecompressStreamOptions,
) DecompressStream(@TypeOf(reader, options)) {
return DecompressStream(@TypeOf(reader), options).init(allocator, reader);
}
pub fn decompressStream( pub fn decompressStream(
allocator: Allocator, allocator: Allocator,
reader: anytype, reader: anytype,
comptime window_size_max: usize, ) DecompressStream(@TypeOf(reader), .{}) {
) DecompressStream(@TypeOf(reader), true, window_size_max) { return DecompressStream(@TypeOf(reader), .{}).init(allocator, reader);
return DecompressStream(@TypeOf(reader), true, 8 * (1 << 20)).init(allocator, reader);
} }
fn testDecompress(data: []const u8) ![]u8 { fn testDecompress(data: []const u8) ![]u8 {
var in_stream = std.io.fixedBufferStream(data); var in_stream = std.io.fixedBufferStream(data);
var zstd_stream = decompressStream(std.testing.allocator, in_stream.reader(), 1 << 23); var zstd_stream = decompressStream(std.testing.allocator, in_stream.reader());
defer zstd_stream.deinit(); defer zstd_stream.deinit();
const result = zstd_stream.reader().readAllAlloc(std.testing.allocator, std.math.maxInt(usize)); const result = zstd_stream.reader().readAllAlloc(std.testing.allocator, std.math.maxInt(usize));
return result; return result;