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

stringEscape

Public Function
std.zig.stringEscape
pub fn stringEscape(bytes: []const u8, w: *Writer) Writer.Error!void

Print the string as escaped contents of a double quoted string.

The following transformations are made:

  • escaped: '\n', '\r', '\t', '\', '"'
  • hex-encoded: ascii control characters

Everything else is passed through unmodified.

Params

File

zig.zig:547
547
548
549
pub fn stringEscape(bytes: []const u8, w: *Writer) Writer.Error!void {
    _ = try stringEscapeCounting(bytes, w);
}