std.EarlyEOFReader: rename to LimitedReader

Author: andrewrk

CMakeLists.txt

@@ -377,9 +377,9 @@ set(ZIG_STAGE2_SOURCES
     "${CMAKE_SOURCE_DIR}/lib/std/io/change_detection_stream.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/counting_reader.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/counting_writer.zig"
-    "${CMAKE_SOURCE_DIR}/lib/std/io/early_eof_reader.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/find_byte_writer.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/fixed_buffer_stream.zig"
+    "${CMAKE_SOURCE_DIR}/lib/std/io/limited_reader.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/reader.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/seekable_stream.zig"
     "${CMAKE_SOURCE_DIR}/lib/std/io/writer.zig"

lib/std/fs/file.zig

@@ -726,7 +726,7 @@ pub const File = struct {
 
         var fifo = std.fifo.LinearFifo(u8, .{ .Static = 4096 }).init();
         if (args.in_len) |len| {
-            var stream = std.io.earlyEOFReader(in_file.reader(), len);
+            var stream = std.io.limitedReader(in_file.reader(), len);
             try fifo.pump(stream.reader(), self.writer());
         } else {
             try fifo.pump(in_file.reader(), self.writer());

lib/std/io.zig

@@ -125,8 +125,8 @@ pub const fixedBufferStream = @import("io/fixed_buffer_stream.zig").fixedBufferS
 pub const CWriter = @import("io/c_writer.zig").CWriter;
 pub const cWriter = @import("io/c_writer.zig").cWriter;
 
-pub const EarlyEOFReader = @import("io/early_eof_reader.zig").EarlyEOFReader;
-pub const earlyEOFReader = @import("io/early_eof_reader.zig").earlyEOFReader;
+pub const LimitedReader = @import("io/limited_reader.zig").LimitedReader;
+pub const limitedReader = @import("io/limited_reader.zig").limitedReader;
 
 pub const CountingWriter = @import("io/counting_writer.zig").CountingWriter;
 pub const countingWriter = @import("io/counting_writer.zig").countingWriter;

lib/std/io/early_eof_reader.zig renamed to lib/std/io/limited_reader.zig

@@ -8,7 +8,7 @@ const io = std.io;
 const assert = std.debug.assert;
 const testing = std.testing;
 
-pub fn EarlyEOFReader(comptime ReaderType: type) type {
+pub fn LimitedReader(comptime ReaderType: type) type {
     return struct {
         inner_reader: ReaderType,
         bytes_left: u64,
@@ -31,16 +31,16 @@ pub fn EarlyEOFReader(comptime ReaderType: type) type {
     };
 }
 
-/// Returns an initialised `EarlyEOFReader`
+/// Returns an initialised `LimitedReader`
 /// `bytes_left` is a `u64` to be able to take 64 bit file offsets
-pub fn earlyEOFReader(inner_reader: anytype, bytes_left: u64) EarlyEOFReader(@TypeOf(inner_reader)) {
+pub fn limitedReader(inner_reader: anytype, bytes_left: u64) LimitedReader(@TypeOf(inner_reader)) {
     return .{ .inner_reader = inner_reader, .bytes_left = bytes_left };
 }
 
-test "io.EarlyEOFReader" {
+test "basic usage" {
     const data = "hello world";
     var fbs = std.io.fixedBufferStream(data);
-    var early_stream = earlyEOFReader(fbs.reader(), 3);
+    var early_stream = limitedReader(fbs.reader(), 3);
 
     var buf: [5]u8 = undefined;
     testing.expectEqual(@as(usize, 3), try early_stream.reader().read(&buf));