libexplain/rename.h File Reference

explain rename(2) errors More...

#include <libexplain/gcc_attributes.h>

Go to the source code of this file.

Functions
void	explain_rename_or_die (const char *oldpath, const char *newpath)
int	explain_rename_on_error (const char *oldpath, const char *newpath) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_rename (const char *oldpath, const char *newpath) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_rename (int errnum, const char *oldpath, const char *newpath) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_rename (char *message, int message_size, const char *oldpath, const char *newpath)
void	explain_message_errno_rename (char *message, int message_size, int errnum, const char *oldpath, const char *newpath)

---

Detailed Description

explain rename(2) errors

Definition in file rename.h.

---

Function Documentation

const char* explain_errno_rename	(	int	errnum,
		const char *	oldpath,
		const char *	newpath
	)

The explain_errno_rename function is used to obtain an explanation of an error returned by the rename(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

This function is intended to be used in a fashion similar to the following example:

 if (rename(oldpath, newpath) < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_rename(err, oldpath, newpath));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_rename_or_die function.

Parameters:

errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
oldpath	The original oldpath, exactly as passed to the rename(2) system call.
newpath	The original newpath, exactly as passed to the rename(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

void explain_message_errno_rename	(	char *	message,
		int	message_size,
		int	errnum,
		const char *	oldpath,
		const char *	newpath
	)

The explain_message_errno_rename function is used to obtain an explanation of an error returned by the rename(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

This function is intended to be used in a fashion similar to the following example:

 if (rename(oldpath, newpath) < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_rename(message, sizeof(message), err, oldpath,
         newpath);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_rename_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
oldpath	The original oldpath, exactly as passed to the rename(2) system call.
newpath	The original newpath, exactly as passed to the rename(2) system call.

void explain_message_rename	(	char *	message,
		int	message_size,
		const char *	oldpath,
		const char *	newpath
	)

The explain_message_rename function is used to obtain an explanation of an error returned by the rename(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

This function is intended to be used in a fashion similar to the following example:

 if (rename(oldpath, newpath) < 0)
 {
     char message[3000];
     explain_message_rename(message, sizeof(message), oldpath, newpath);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_rename_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
oldpath	The original oldpath, exactly as passed to the rename(2) system call.
newpath	The original newpath, exactly as passed to the rename(2) system call.

const char* explain_rename	(	const char *	oldpath,
		const char *	newpath
	)

The explain_rename function is used to obtain an explanation of an error returned by the rename(2) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

This function is intended to be used in a fashion similar to the following example:

 if (rename(oldpath, newpath) < 0)
 {
     fprintf(stderr, "%s\n", explain_rename(oldpath, newpath));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_rename_or_die function.

Parameters:

oldpath	The original oldpath, exactly as passed to the rename(2) system call.
newpath	The original newpath, exactly as passed to the rename(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

int explain_rename_on_error	(	const char *	oldpath,
		const char *	newpath
	)

The explain_rename_on_error function is used to call the rename(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_rename(3) function.

This function is intended to be used in a fashion similar to the following example:

 if (explain_rename_on_error(oldpath, newpath) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

oldpath	The oldpath, exactly as to be passed to the rename(2) system call.
newpath	The newpath, exactly as to be passed to the rename(2) system call.

Returns:

The value returned by the wrapped rename(2) system call.

void explain_rename_or_die	(	const char *	oldpath,
		const char *	newpath
	)

The explain_rename_or_die function is used to call the rename(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_rename(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

This function is intended to be used in a fashion similar to the following example:

 explain_rename_or_die(oldpath, newpath);

Parameters:

oldpath	The oldpath, exactly as to be passed to the rename(2) system call.
newpath	The newpath, exactly as to be passed to the rename(2) system call.

Returns:

This function only returns on success. On failure, prints an explanation and exits, it does not return.