Function fstatat [src]

Similar to fstat, but returns stat of a resource pointed to by pathname which is relative to dirfd handle. On WASI, pathname should be encoded as valid UTF-8. On other platforms, pathname is an opaque sequence of bytes with no particular encoding. See also fstatatZ and std.os.fstatat_wasi.

Prototype

pub fn fstatat(dirfd: fd_t, pathname: []const u8, flags: u32) FStatAtError!Stat

Parameters

dirfd: fd_tpathname: []const u8flags: u32

Possible Errors

AccessDenied FStatError

In WASI, this error may occur when the file descriptor does not hold the required rights to get its filestat information.

FileNotFound

InvalidUtf8

WASI-only; file paths must be valid UTF-8.

NameTooLong

PermissionDenied FStatError

SymLinkLoop

SystemResources FStatError

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.

Source

  pub fn fstatat(dirfd: fd_t, pathname: []const u8, flags: u32) FStatAtError!Stat {
    if (native_os == .wasi and !builtin.link_libc) {
        const filestat = try std.os.fstatat_wasi(dirfd, pathname, .{
            .SYMLINK_FOLLOW = (flags & AT.SYMLINK_NOFOLLOW) == 0,
        });
        return Stat.fromFilestat(filestat);
    } else if (native_os == .windows) {
        @compileError("fstatat is not yet implemented on Windows");
    } else {
        const pathname_c = try toPosixPath(pathname);
        return fstatatZ(dirfd, &pathname_c, flags);
    }
}  