Merge pull request #25 from pedropark99/12-file-op

Add new chapter about File and I/O operations

Author: pedropark99

.gitignore

@@ -10,6 +10,7 @@
 ./lldb/
 lldb
 
+foo.txt
 
 *.o
 *.a

Chapters/01-base64.qmd

@@ -10,7 +10,7 @@ source("../zig_engine.R")
 ```
 
 
-# Building a base64 encoder/decoder {#sec-base64}
+# Project 1 - Building a base64 encoder/decoder {#sec-base64}
 
 As our first small project, I want to implement with you a base64 encoder/decoder in Zig.
 Base64 is an encoding system which translates binary data to text.

Chapters/04-http-server.qmd

@@ -15,7 +15,7 @@ knitr::opts_chunk$set(
 
 
 
-# Building a HTTP Server from scratch
+# Project 2 - Building a HTTP Server from scratch
 
 In this chapter, I want to implement a new
 small project with you. This time, we are going
@@ -328,7 +328,7 @@ terminates as soon as the connection is accepted.
 
 
 
-### Reading the message from the client
+### Reading the message from the client {#sec-read-http-message}
 
 Now that we have a connection established, i.e. the connection
 object that we created through the `accept()` function, we can now

Chapters/10-stack-project.qmd

@@ -14,7 +14,7 @@ knitr::opts_chunk$set(
 ```
 
 
-# Building a stack data structure
+# Project 3 - Building a stack data structure
 
 In this chapter we are going to implement a stack data structure as our next small project
 in this book. Implementing basic data structures in any language is kind of a

Chapters/12-file-op.qmd

@@ -25,8 +25,10 @@ You can find instructions on how to install these pieces of software by clicking
 ### Install R packages
 
 After you installed the three pieces of software listed above, you should run the `dependencies.R` R script, to install
-some R packages that are used across the book. Just run
-the command below in your terminal, and you should be fine.
+some R packages that are used across the book. Just run the command below in your terminal, and you should be fine.
+
+OBS: If you are on Linux or MacOS, this command will probably take some time to run, because every single dependency get's built from source.
+In Windows, this usually doesn't take that long because pre-built binaries are usually available.
 
 ```bash
 Rscript dependencies.R

Figures/Powerpoint/buffered-io.odp

@@ -0,0 +1,10 @@
+const std = @import("std");
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    const file = try cwd.openFile("foo.txt", .{ .mode = .write_only });
+    defer file.close();
+    try file.seekFromEnd(0);
+    var fw = file.writer();
+    _ = try fw.writeAll("Some random text to write\n");
+}

Figures/Powerpoint/unbuffered-io.odp

@@ -0,0 +1,14 @@
+const std = @import("std");
+const stdout = std.io.getStdOut().writer();
+pub fn main() !void {
+    var file = try std.fs.cwd().openFile("ZigExamples/file-io/lorem.txt", .{});
+    defer file.close();
+    var buffered = std.io.bufferedReader(file.reader());
+    var reader = buffered.reader();
+
+    var buffer: [1000]u8 = undefined;
+    @memset(buffer[0..], 0);
+
+    _ = try reader.readUntilDelimiterOrEof(buffer[0..], '\n');
+    try stdout.print("{s}\n", .{buffer});
+}

Figures/buffered-io.png

@@ -0,0 +1,6 @@
+const std = @import("std");
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    try cwd.copyFile("foo.txt", cwd, "ZigExamples/file-io/foo.txt", .{});
+}

Figures/cwd.png

@@ -0,0 +1,6 @@
+const std = @import("std");
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    const file = try cwd.createFile("foo.txt", .{});
+    file.close();
+}

Figures/unbuffered-io.png

@@ -0,0 +1,17 @@
+const std = @import("std");
+const stdout = std.io.getStdOut().writer();
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    const file = try cwd.createFile("foo.txt", .{ .read = true });
+    defer file.close();
+
+    var fw = file.writer();
+    _ = try fw.writeAll("We are going to read this line\n");
+
+    var buffer: [300]u8 = undefined;
+    @memset(buffer[0..], 0);
+    try file.seekTo(0);
+    var fr = file.reader();
+    _ = try fr.readAll(buffer[0..]);
+    try stdout.print("{s}\n", .{buffer});
+}

README.md

@@ -0,0 +1,9 @@
+const std = @import("std");
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    const file = try cwd.createFile("foo.txt", .{});
+    defer file.close();
+    // Do things with the file ...
+    var fw = file.writer();
+    _ = try fw.writeAll("Writing this line to the file\n");
+}

ZigExamples/file-io/append_to_file.zig

@@ -0,0 +1,7 @@
+const std = @import("std");
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    try cwd.makeDir("src");
+    try cwd.deleteDir("src");
+}

ZigExamples/file-io/buff_io.zig

@@ -0,0 +1,6 @@
+const std = @import("std");
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    try cwd.deleteFile("foo.txt");
+}

ZigExamples/file-io/copy_file.zig

@@ -0,0 +1,11 @@
+const std = @import("std");
+const stdout = std.io.getStdOut().writer();
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    const dir = try cwd.openDir("ZigExamples/file-io/", .{ .iterate = true });
+    var it = dir.iterate();
+    while (try it.next()) |entry| {
+        try stdout.print("File name: {s}\n", .{entry.name});
+    }
+}

ZigExamples/file-io/create_file.zig

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed tincidunt erat sed nulla ornare, nec aliquet ex laoreet. Ut nec rhoncus nunc. Integer magna metus, ultrices eleifend porttitor ut, finibus ut tortor. Maecenas sapien justo, finibus tincidunt dictum ac, semper et lectus. Vivamus molestie egestas orci ac viverra. Pellentesque nec arcu facilisis, euismod eros eu, sodales nisl. Ut egestas sagittis arcu, in accumsan sapien rhoncus sit amet. Aenean neque lectus, imperdiet ac lobortis a, ullamcorper sed massa. Nullam porttitor porttitor erat nec dapibus. Ut vel dui nec nulla vulputate molestie eget non nunc. Ut commodo luctus ipsum, in finibus libero feugiat eget. Etiam vel ante at urna tincidunt posuere sit amet ut felis. Maecenas finibus suscipit tristique. Donec viverra non sapien id suscipit. 

ZigExamples/file-io/create_file_and_read.zig

@@ -0,0 +1,7 @@
+const std = @import("std");
+
+pub fn main() !void {
+    const cwd = std.fs.cwd();
+    try cwd.makeDir("src");
+    try cwd.makePath("src/decoders/jpg/");
+}

ZigExamples/file-io/create_file_and_write_toit.zig

@@ -0,0 +1,10 @@
+const std = @import("std");
+const stdout = std.io.getStdOut().writer();
+const stdin = std.io.getStdIn().reader();
+pub fn main() !void {
+    try stdout.writeAll("Type your name\n");
+    var buffer: [20]u8 = undefined;
+    @memset(buffer[0..], 0);
+    _ = try stdin.readUntilDelimiterOrEof(buffer[0..], '\n');
+    try stdout.print("Your name is: {s}\n", .{buffer});
+}

ZigExamples/file-io/delete-dir.zig

@@ -0,0 +1,5 @@
+const std = @import("std");
+const stdout = std.io.getStdOut().writer();
+pub fn main() !void {
+    try stdout.print("Hello World!\n", .{});
+}

ZigExamples/file-io/delete_file.zig

@@ -21,6 +21,7 @@ book:
     - Chapters/09-error-handling.qmd
     - Chapters/09-data-structures.qmd
     - Chapters/10-stack-project.qmd
+    - Chapters/12-file-op.qmd
     - references.qmd
 
 bibliography: references.bib