Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

getStackTrace

Only valid once has_induced_failure == true

FailingAllocator.getStackTrace

pub fn getStackTrace(self: *FailingAllocator) std.debug.StackTrace

File

lib/std/testing/FailingAllocator.zig:134

Code

pub fn getStackTrace(self: *FailingAllocator) std.debug.StackTrace {
    std.debug.assert(self.has_induced_failure);
    var len: usize = 0;
    while (len < self.stack_addresses.len and self.stack_addresses[len] != 0) {
        len += 1;
    }
    return .{
        .return_addresses = self.stack_addresses[0..len],
        .skipped = if (len == self.stack_addresses.len) .unknown else .none,
    };
}