Zig 0.17.0-dev (Split by item)

?

× Shortcut keys

?: Show these tips

S: Focus search field

Esc: Clear focus & close tips

U: Jump to source code

↑: Move up in search results

↓: Move down in search results

↵: Go to active search result

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 standard library. Public Function

parseAlloc

Doc Source

Public Function

std.zig.string_literal.parseAlloc

pub fn parseAlloc(allocator: std.mem.Allocator, bytes: []const u8) ParseError![]u8

Higher level API. Does not return extra info about parse errors. Caller owns returned memory.

Params

allocator: std.mem.Allocator
bytes: []const u8

Errors

OutOfMemory
InvalidLiteral

File

zig/string_literal.zig:360

pub fn parseAlloc(allocator: std.mem.Allocator, bytes: []const u8) ParseError![]u8 {
    var aw: Writer.Allocating = .init(allocator);
    defer aw.deinit();
    const result = parseWrite(&aw.writer, bytes) catch |err| switch (err) {
        error.WriteFailed => return error.OutOfMemory,
    };
    switch (result) {
        .success => return aw.toOwnedSlice(),
        .failure => return error.InvalidLiteral,
    }
}