diff options
| author | Andrew Kelley <andrew@ziglang.org> | 2021-01-11 16:52:29 -0700 |
|---|---|---|
| committer | Andrew Kelley <andrew@ziglang.org> | 2021-01-11 16:52:29 -0700 |
| commit | 483c057a771aca3b045ec8148fa5fb1a5e28fa17 (patch) | |
| tree | 7ee84cd567bac20ed769845b0e469fe39e1c2f6c /lib/std/io | |
| parent | 3468872d8376602fdbfdb5b0d6d582c278ad1990 (diff) | |
| parent | d68adc5382a29687d2e24e27d9877473346a25e1 (diff) | |
| download | zig-483c057a771aca3b045ec8148fa5fb1a5e28fa17.tar.gz zig-483c057a771aca3b045ec8148fa5fb1a5e28fa17.zip | |
Merge branch 'clean up writeFileAllUnseekable by using readers'
closes #7156
Diffstat (limited to 'lib/std/io')
| -rw-r--r-- | lib/std/io/limited_reader.zig | 50 | ||||
| -rw-r--r-- | lib/std/io/reader.zig | 3 |
2 files changed, 52 insertions, 1 deletions
diff --git a/lib/std/io/limited_reader.zig b/lib/std/io/limited_reader.zig new file mode 100644 index 0000000000..734558b1e6 --- /dev/null +++ b/lib/std/io/limited_reader.zig @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: MIT +// Copyright (c) 2015-2020 Zig Contributors +// This file is part of [zig](https://ziglang.org/), which is MIT licensed. +// The MIT license requires this copyright notice to be included in all copies +// and substantial portions of the software. +const std = @import("../std.zig"); +const io = std.io; +const assert = std.debug.assert; +const testing = std.testing; + +pub fn LimitedReader(comptime ReaderType: type) type { + return struct { + inner_reader: ReaderType, + bytes_left: u64, + + pub const Error = ReaderType.Error; + pub const Reader = io.Reader(*Self, Error, read); + + const Self = @This(); + + pub fn read(self: *Self, dest: []u8) Error!usize { + const max_read = std.math.min(self.bytes_left, dest.len); + const n = try self.inner_reader.read(dest[0..max_read]); + self.bytes_left -= n; + return n; + } + + pub fn reader(self: *Self) Reader { + return .{ .context = self }; + } + }; +} + +/// Returns an initialised `LimitedReader` +/// `bytes_left` is a `u64` to be able to take 64 bit file offsets +pub fn limitedReader(inner_reader: anytype, bytes_left: u64) LimitedReader(@TypeOf(inner_reader)) { + return .{ .inner_reader = inner_reader, .bytes_left = bytes_left }; +} + +test "basic usage" { + const data = "hello world"; + var fbs = std.io.fixedBufferStream(data); + var early_stream = limitedReader(fbs.reader(), 3); + + var buf: [5]u8 = undefined; + testing.expectEqual(@as(usize, 3), try early_stream.reader().read(&buf)); + testing.expectEqualSlices(u8, data[0..3], buf[0..3]); + testing.expectEqual(@as(usize, 0), try early_stream.reader().read(&buf)); + testing.expectError(error.EndOfStream, early_stream.reader().skipBytes(10, .{})); +} diff --git a/lib/std/io/reader.zig b/lib/std/io/reader.zig index 705eb9e816..e174051518 100644 --- a/lib/std/io/reader.zig +++ b/lib/std/io/reader.zig @@ -271,8 +271,9 @@ pub fn Reader( buf_size: usize = 512, }; + // `num_bytes` is a `u64` to match `off_t` /// Reads `num_bytes` bytes from the stream and discards them - pub fn skipBytes(self: Self, num_bytes: usize, comptime options: SkipBytesOptions) !void { + pub fn skipBytes(self: Self, num_bytes: u64, comptime options: SkipBytesOptions) !void { var buf: [options.buf_size]u8 = undefined; var remaining = num_bytes; |
