add src() for std.builtin.SourceLocation

Author: karlseguin

readme.md

@@ -18,6 +18,9 @@ try logz.setup(allocator, .{
 
 // other places in your code
 logz.info().string("path", req.url.path).int("ms", elapsed).log();
+
+// The src(@src()) + err(err) combo is great for errors
+logz.err().src(@src()).err(err).log();
 ```
 
 Alternatively, 1 or more explicit pools can be created:
@@ -69,6 +72,7 @@ The logger can log:
 * stringSafe(key: []const u8, value: ?[]const u8 - assumes value doesn't need to be encoded
 * stringSafeZ(key: []const u8, value: ?[*:0]const u8 - assumes value doesn't need to be encoded
 * ctx(value: []const u8) - same as `stringSafe("@ctx", value)`
+* src(value: std.builtin.SourceLocation) - Logs an `std.builtin.SourceLocation`, the type of value you get from the `@src()` builtin.
 
 ### Log Level
 Pools are configured with a minimum log level:

src/kv.zig

@@ -74,8 +74,15 @@ pub const Kv = struct {
 	pub fn ctx(self: *Kv, value: []const u8) void {
 		if (!self.writeKeyForValue("@ctx", value.len)) return;
 		const pos = self.pos;
-		@memcpy(self.buf[pos..pos+value.len], value);
-		self.pos = pos + value.len;
+		const end = pos+value.len;
+		@memcpy(self.buf[pos..end], value);
+		self.pos = end;
+	}
+
+	pub fn src(self: *Kv, value: std.builtin.SourceLocation) void {
+		self.string("@src.file", value.file);
+		self.string("@src.fn", value.fn_name);
+		self.int("@src.line", value.line);
 	}
 
 	pub fn string(self: *Kv, key: []const u8, nvalue: ?[]const u8) void {
@@ -103,8 +110,9 @@ pub const Kv = struct {
 		}
 
 		if (!needs_escape) {
-			@memcpy(self.buf[pos..pos+value.len], value);
-			self.pos = pos + value.len;
+			const end = pos+value.len;
+			@memcpy(self.buf[pos..end], value);
+			self.pos = end;
 			return;
 		}
 
@@ -164,8 +172,9 @@ pub const Kv = struct {
 		if (value) |v| {
 			if (!self.writeKeyForValue(key, v.len)) return;
 			const pos = self.pos;
-			@memcpy(self.buf[pos..pos+v.len], v);
-			self.pos = pos + v.len;
+			const end = pos+v.len;
+			@memcpy(self.buf[pos..end], v);
+			self.pos = end;
 		} else {
 			self.writeNull(key);
 		}
@@ -386,8 +395,9 @@ pub const Kv = struct {
 			pos += 1;
 		}
 
-		@memcpy(buf[pos..pos+key.len], key);
-		pos += key.len;
+		const end = pos+key.len;
+		@memcpy(buf[pos..end], key);
+		pos = end;
 		buf[pos] = '=';
 		self.pos = pos + 1;
 		return true;
@@ -1047,6 +1057,25 @@ test "kv: ctx" {
 	}
 }
 
+test "kv: src" {
+	var pool = try Pool.init(t.allocator, .{.pool_size = 1});
+	defer pool.deinit();
+
+	var out = std.ArrayList(u8).init(t.allocator);
+	try out.ensureTotalCapacity(100);
+	defer out.deinit();
+
+	{
+		// normal strings
+		var kv = pool.acquire() orelse unreachable;
+		defer pool.release(kv);
+
+		kv.src(@src());
+		try kv.logTo(out.writer());
+		try t.expectString(out.items, "@ts=9999999999999 @src.file=src/kv.zig @src.fn=\"test.kv: src\" @src.line=1073\n");
+	}
+}
+
 test "kv: fmt" {
 	var pool = try Pool.init(t.allocator, .{.pool_size = 1});
 	defer pool.deinit();

src/logz.zig

@@ -79,6 +79,14 @@ pub const Logger = struct {
 		return self;
 	}
 
+	pub fn src(self: Self, value: std.builtin.SourceLocation) Self {
+		switch (self.inner) {
+			.noop => {},
+			inline else => |l| l.src(value),
+		}
+		return self;
+	}
+
 	pub fn fmt(self: Self, key: []const u8, comptime format: []const u8, values: anytype) Self {
 		switch (self.inner) {
 			.noop => {},