NAME

rm_rf, rm_rfat, rm_rf_tmp, rm_rf_tmpat, rm_rf_in_tmp, rm_rf_in_tmpat - remove an entire directory entry

rmstar, rmstarat, rmstar_tmp, rmstar_tmpat, rmstar_in_tmp, rmstar_in_tmpat - remove the full content of a directory

SYNOPSIS

#include <fcntl.h> /* AT_FDCWD */
#include <limb/djbunix.h>

int rm_rf(const char *name)
int rm_rfat(int fd, const char *name)

int rm_rf_tmp(const char *name, stralloc *sa)
int rm_rf_tmpat(int fd, const char *name, stralloc *sa)

int rm_rf_in_tmp(stralloc *sa, size_t offset)
int rm_rf_in_tmpat(int fd, stralloc *sa, size_t offset)

int rmstar(const char *name)
int rmstarat(int fd, const char *name)

int rmstar_tmp(const char *name, stralloc *sa)
int rmstar_tmpat(int fd, const char *name, stralloc *sa)

int rmstar_in_tmpat(int fd, stralloc *sa, size_t offset)

DESCRIPTION

The rm_rf() function removes the entire directory entry named name from the filesystem, whether a file, a directory (empty or not), etc.

The rm_rfat() function is similar to rm_rf() except when name specifies a relative path, relative to the directory associated with the file descriptor fd instead of the current working directory. If passed the special value AT_FDCWD in the fd parameter, the current working directory is used.

The rm_rf_tmp() and rm_rf_tmpat() functions are similar to rm_rf() and rm_rfat() respectively, except that they will use the given stralloc sa as heap-allocated temporary space.

The rm_rf_in_tp() and rm_rf_in_tmpat() functions are similar to rm_rm_tmp() and rm_rm_tmpat() respectively, except that they expect sa to contain a NUL-terminated string of the name at offset offset.

The rmstar() function removes the full content of directory name recursively (leaving only the (empty) directory itself).

The rmstarat() function is similar to rmstar() except when name specifies a relative path, relative to the directory associated with the file descriptor fd instead of the current working directory. If passed the special value AT_FDCWD in the fd parameter, the current working directory is used.

The rmstar_tmp() and rmstar_tmpat() function are similar to rmstar() and rm_starat() respectively, except that they will use the given stralloc sa as heap-allocated temporary space.

The rmstar_in_tmpat() function is similar to rmstar_tmpat() except that it expects sa to contain a NUL-terminated string of the name at offset offset.

RETURN VALUE

Upon successful completion, these functions return 0. Otherwise, they return -1 and set errno to indicate the error.

Note that these functions are not atomic and, in case of failure, might leave the relevant directory partially removed.

ERRORS

These functions may fail if :

The rm*at() family of functions may also fail and set errno for any of the errors specified for the functions unlinkat(3) and sa_lsat(3).

The other family of functions may also fail and set errno for any of the errors specified for the functions unlink(3), rmdir(3) and sa_ls(3).