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

realPath

Public Function
std.Io.Dir.realPath
pub fn realPath(dir: Dir, io: Io, out_buffer: []u8) RealPathError!usize

Obtains the canonicalized absolute path name of sub_path relative to this Dir. If sub_path is absolute, ignores this Dir handle and obtains the canonicalized absolute pathname of sub_path argument.

This function has limited platform support, and using it can lead to unnecessary failures and race conditions. It is generally advisable to avoid this function entirely.

Params

  • dir: Dir
  • io: Io
  • out_buffer: []u8

File

Io/Dir.zig:915
915
916
917
pub fn realPath(dir: Dir, io: Io, out_buffer: []u8) RealPathError!usize {
    return io.vtable.dirRealPath(io.userdata, dir, out_buffer);
}