Function unlinkat [src]

Delete a file name and possibly the file it refers to, based on an open directory handle. On Windows, file_path should be encoded as WTF-8. On WASI, file_path should be encoded as valid UTF-8. On other platforms, file_path is an opaque sequence of bytes with no particular encoding. Asserts that the path parameter has no null bytes.

Prototype

pub fn unlinkat(dirfd: fd_t, file_path: []const u8, flags: u32) UnlinkatError!void

Parameters

dirfd: fd_tfile_path: []const u8flags: u32

Possible Errors

AccessDenied UnlinkError

In WASI, this error may occur when the file descriptor does not hold the required rights to unlink a resource by path relative to it.

BadPathName UnlinkError

On Windows, file paths cannot contain these characters: '/', '*', '?', '"', '<', '>', '|'

DirNotEmpty

When passing AT.REMOVEDIR, this error occurs when the named directory is not empty.

FileBusy UnlinkError

FileNotFound UnlinkError

FileSystem UnlinkError

InvalidUtf8 UnlinkError

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

InvalidWtf8 UnlinkError

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

IsDir UnlinkError

NameTooLong UnlinkError

NetworkNotFound UnlinkError

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

NotDir UnlinkError

PermissionDenied UnlinkError

ReadOnlyFileSystem UnlinkError

SymLinkLoop UnlinkError

SystemResources UnlinkError

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 unlinkat(dirfd: fd_t, file_path: []const u8, flags: u32) UnlinkatError!void {
    if (native_os == .windows) {
        const file_path_w = try windows.sliceToPrefixedFileW(dirfd, file_path);
        return unlinkatW(dirfd, file_path_w.span(), flags);
    } else if (native_os == .wasi and !builtin.link_libc) {
        return unlinkatWasi(dirfd, file_path, flags);
    } else {
        const file_path_c = try toPosixPath(file_path);
        return unlinkatZ(dirfd, &file_path_c, flags);
    }
}  