aboutsummaryrefslogtreecommitdiff
path: root/lib/std/Io/stream_source.zig
diff options
context:
space:
mode:
authorRue <78876133+IOKG04@users.noreply.github.com>2025-07-28 14:54:52 +0200
committerGitHub <noreply@github.com>2025-07-28 14:54:52 +0200
commit5381e7891dcdd7b6a9e74250cdcce221fe464cdc (patch)
tree4c74744ed84120dccae6dc9811ce945911108a17 /lib/std/Io/stream_source.zig
parent84ae54fbe64a15301317716e7f901d81585332d5 (diff)
parentdea3ed7f59347e87a1b8fa237202873988084ae8 (diff)
downloadzig-5381e7891dcdd7b6a9e74250cdcce221fe464cdc.tar.gz
zig-5381e7891dcdd7b6a9e74250cdcce221fe464cdc.zip
Merge branch 'ziglang:master' into some-documentation-updates-0
Diffstat (limited to 'lib/std/Io/stream_source.zig')
-rw-r--r--lib/std/Io/stream_source.zig127
1 files changed, 0 insertions, 127 deletions
diff --git a/lib/std/Io/stream_source.zig b/lib/std/Io/stream_source.zig
deleted file mode 100644
index 2a3527e479..0000000000
--- a/lib/std/Io/stream_source.zig
+++ /dev/null
@@ -1,127 +0,0 @@
-const std = @import("../std.zig");
-const builtin = @import("builtin");
-const io = std.io;
-
-/// Provides `io.GenericReader`, `io.GenericWriter`, and `io.SeekableStream` for in-memory buffers as
-/// well as files.
-/// For memory sources, if the supplied byte buffer is const, then `io.GenericWriter` is not available.
-/// The error set of the stream functions is the error set of the corresponding file functions.
-pub const StreamSource = union(enum) {
- // TODO: expose UEFI files to std.os in a way that allows this to be true
- const has_file = (builtin.os.tag != .freestanding and builtin.os.tag != .uefi);
-
- /// The stream access is redirected to this buffer.
- buffer: io.FixedBufferStream([]u8),
-
- /// The stream access is redirected to this buffer.
- /// Writing to the source will always yield `error.AccessDenied`.
- const_buffer: io.FixedBufferStream([]const u8),
-
- /// The stream access is redirected to this file.
- /// On freestanding, this must never be initialized!
- file: if (has_file) std.fs.File else void,
-
- pub const ReadError = io.FixedBufferStream([]u8).ReadError || (if (has_file) std.fs.File.ReadError else error{});
- pub const WriteError = error{AccessDenied} || io.FixedBufferStream([]u8).WriteError || (if (has_file) std.fs.File.WriteError else error{});
- pub const SeekError = io.FixedBufferStream([]u8).SeekError || (if (has_file) std.fs.File.SeekError else error{});
- pub const GetSeekPosError = io.FixedBufferStream([]u8).GetSeekPosError || (if (has_file) std.fs.File.GetSeekPosError else error{});
-
- pub const Reader = io.GenericReader(*StreamSource, ReadError, read);
- pub const Writer = io.GenericWriter(*StreamSource, WriteError, write);
- pub const SeekableStream = io.SeekableStream(
- *StreamSource,
- SeekError,
- GetSeekPosError,
- seekTo,
- seekBy,
- getPos,
- getEndPos,
- );
-
- pub fn read(self: *StreamSource, dest: []u8) ReadError!usize {
- switch (self.*) {
- .buffer => |*x| return x.read(dest),
- .const_buffer => |*x| return x.read(dest),
- .file => |x| if (!has_file) unreachable else return x.read(dest),
- }
- }
-
- pub fn write(self: *StreamSource, bytes: []const u8) WriteError!usize {
- switch (self.*) {
- .buffer => |*x| return x.write(bytes),
- .const_buffer => return error.AccessDenied,
- .file => |x| if (!has_file) unreachable else return x.write(bytes),
- }
- }
-
- pub fn seekTo(self: *StreamSource, pos: u64) SeekError!void {
- switch (self.*) {
- .buffer => |*x| return x.seekTo(pos),
- .const_buffer => |*x| return x.seekTo(pos),
- .file => |x| if (!has_file) unreachable else return x.seekTo(pos),
- }
- }
-
- pub fn seekBy(self: *StreamSource, amt: i64) SeekError!void {
- switch (self.*) {
- .buffer => |*x| return x.seekBy(amt),
- .const_buffer => |*x| return x.seekBy(amt),
- .file => |x| if (!has_file) unreachable else return x.seekBy(amt),
- }
- }
-
- pub fn getEndPos(self: *StreamSource) GetSeekPosError!u64 {
- switch (self.*) {
- .buffer => |*x| return x.getEndPos(),
- .const_buffer => |*x| return x.getEndPos(),
- .file => |x| if (!has_file) unreachable else return x.getEndPos(),
- }
- }
-
- pub fn getPos(self: *StreamSource) GetSeekPosError!u64 {
- switch (self.*) {
- .buffer => |*x| return x.getPos(),
- .const_buffer => |*x| return x.getPos(),
- .file => |x| if (!has_file) unreachable else return x.getPos(),
- }
- }
-
- pub fn reader(self: *StreamSource) Reader {
- return .{ .context = self };
- }
-
- pub fn writer(self: *StreamSource) Writer {
- return .{ .context = self };
- }
-
- pub fn seekableStream(self: *StreamSource) SeekableStream {
- return .{ .context = self };
- }
-};
-
-test "refs" {
- std.testing.refAllDecls(StreamSource);
-}
-
-test "mutable buffer" {
- var buffer: [64]u8 = undefined;
- var source = StreamSource{ .buffer = std.io.fixedBufferStream(&buffer) };
-
- var writer = source.writer();
-
- try writer.writeAll("Hello, World!");
-
- try std.testing.expectEqualStrings("Hello, World!", source.buffer.getWritten());
-}
-
-test "const buffer" {
- const buffer: [64]u8 = "Hello, World!".* ++ ([1]u8{0xAA} ** 51);
- var source = StreamSource{ .const_buffer = std.io.fixedBufferStream(&buffer) };
-
- var reader = source.reader();
-
- var dst_buffer: [13]u8 = undefined;
- try reader.readNoEof(&dst_buffer);
-
- try std.testing.expectEqualStrings("Hello, World!", &dst_buffer);
-}