BinaryStream

A fast, reliable, easy to use data manipulation library for Zig.

---

Instalation

zig fetch --save git+https://github.com/SanctumTerra/BinaryStream#master

Now we add it to build.zig

const binarystream_dep = b.dependency("BinaryStream", .{});
exe.root_module.addImport("BinaryStream", binarystream_dep.module("BinaryStream"));

---

Usage

Numbers: Writing && Reading

    const BinaryStream = @import("binarystream").BinaryStream;
    const Endianess = @import("binarystream").Endianess;
    const VarInt = @import("binarystream").VarInt;

    // As a first step we must create a new instance of the BinaryStream
    var stream = BinaryStream.init(std.testing.allocator, null, null);
    // We must defer a deinit, this avoids memory leaks.
    defer stream.deinit();
    
    // Writing data is not complicated, here is an example of how to write a Packet ID.
    const ID: u32 = 0x1234;
    // Writing it to stream using Data Types. 
    try VarInt.write(&stream, packet_id);

    // Lets reset the offset back to 0 before we read.
    stream.offset = 0;

    // Now the reading part
    const read_packet_id = try VarInt.read(&stream);
    std.debug.print("Read Packet {d}", .{read_packet_id});

Strings: Writing && Reading

    // VarString import.
    const VarString = @import("binarystream").VarString;

    // Stream initialization is the same
    const test_string = "Test string";
    try VarString.write(&stream, test_string);

    // Lets reset the offset back to 0 before we read.
    stream.offset = 0;
    const read_string = try VarString.read(&stream);

    // We need to de-allocate strings, as they are owned buffers.
    defer allocator.free(read_string);