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. Private Constant

ArgvToScriptCommandLineError

Doc Source

Private Constant

std.Io.Threaded.ArgvToScriptCommandLineError

const ArgvToScriptCommandLineError = error

Errors

OutOfMemory

InvalidWtf8

InvalidBatchScriptArg

NUL (U+0000), LF (U+000A), CR (U+000D) are not allowed within arguments when executing a .bat/.cmd script.

NUL/LF signifiies end of arguments, so anything afterwards would be lost after execution.
CR is stripped by cmd.exe, so any CR codepoints would be lost after execution.

File

Io/Threaded.zig:16727

const ArgvToScriptCommandLineError = error{
    OutOfMemory,
    InvalidWtf8,
    /// NUL (U+0000), LF (U+000A), CR (U+000D) are not allowed
    /// within arguments when executing a `.bat`/`.cmd` script.
    /// - NUL/LF signifiies end of arguments, so anything afterwards
    ///   would be lost after execution.
    /// - CR is stripped by `cmd.exe`, so any CR codepoints
    ///   would be lost after execution.
    InvalidBatchScriptArg,
}