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

createFileAtomic

Public Function
std.Io.Dir.createFileAtomic
pub fn createFileAtomic(
    dir: Dir,
    io: Io,
    sub_path: []const u8,
    options: CreateFileAtomicOptions,
) CreateFileAtomicError!File.Atomic

Create an unnamed ephemeral file that can eventually be atomically materialized into sub_path.

The returned File.Atomic provides API to emulate the behavior in case it is not directly supported by the underlying operating system.

  • On Windows, sub_path should be encoded as WTF-8.
  • On WASI, sub_path should be encoded as valid UTF-8.
  • On other platforms, sub_path is an opaque sequence of bytes with no particular encoding.

Params

File

Io/Dir.zig:1928
1928
1929
1930
1931
1932
1933
1934
1935
pub fn createFileAtomic(
    dir: Dir,
    io: Io,
    sub_path: []const u8,
    options: CreateFileAtomicOptions,
) CreateFileAtomicError!File.Atomic {
    return io.vtable.dirCreateFileAtomic(io.userdata, dir, sub_path, options);
}