Function realpath [src]

Return the canonicalized absolute pathname. Expands all symbolic links and resolves references to ., .., and extra / characters in pathname. On Windows, pathname should be encoded as WTF-8. On other platforms, pathname is an opaque sequence of bytes with no particular encoding. The return value is a slice of out_buffer, but not necessarily from the beginning. See also realpathZ and realpathW. On Windows, the result is encoded as WTF-8. On other platforms, the result is an opaque sequence of bytes with no particular encoding. Calling this function is usually a bug.

Prototype

pub fn realpath(pathname: []const u8, out_buffer: *[max_path_bytes]u8) RealPathError![]u8

Parameters

pathname: []const u8out_buffer: *[max_path_bytes]u8

Possible Errors

AccessDenied

AntivirusInterference

On Windows, antivirus software is enabled by default. It can be disabled, but Windows Update sometimes ignores the user's preference and re-enables it. When enabled, antivirus software on Windows intercepts file system operations and makes them significantly slower in addition to possibly failing with this error code.

BadPathName

DeviceBusy

FileNotFound

FileSystem

FileTooBig

InputOutput

InvalidWtf8

Windows-only; file paths provided by the user must be valid WTF-8. https://simonsapin.github.io/wtf-8/

IsDir

NameTooLong

NetworkNotFound

On Windows, \\server or \\server\share was not found.

NoDevice

NoSpaceLeft

NotDir

NotSupported

PathAlreadyExists

PermissionDenied

PipeBusy

ProcessFdQuotaExceeded

SharingViolation

SymLinkLoop

SystemFdQuotaExceeded

SystemResources

Unexpected UnexpectedError

The Operating System returned an undocumented error code.

This error is in theory not possible, but it would be better to handle this error than to invoke undefined behavior.

When this error code is observed, it usually means the Zig Standard Library needs a small patch to add the error code to the error set for the respective function.

UnrecognizedVolume

On Windows, the volume does not contain a recognized file system. File system drivers might not be loaded, or the volume may be corrupt.

Source

  pub fn realpath(pathname: []const u8, out_buffer: *[max_path_bytes]u8) RealPathError![]u8 {
    if (native_os == .windows) {
        const pathname_w = try windows.sliceToPrefixedFileW(null, pathname);
        return realpathW(pathname_w.span(), out_buffer);
    } else if (native_os == .wasi and !builtin.link_libc) {
        @compileError("WASI does not support os.realpath");
    }
    const pathname_c = try toPosixPath(pathname);
    return realpathZ(&pathname_c, out_buffer);
}  