explain_statvfs(3)

πŸ“¦
version 1.4.D001 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute

πŸ¦‹ explain_statvfs β€” NAME πŸ¦‹

okay so like, explain_statvfs is a libexplain thing that explains statvfs(2) errors πŸ’… (yes bestie, the manual page is called explain_statvfs(3), we're in the Library Functions Manual, iykyk)


✨ SYNOPSIS ✨

#include <libexplain/statvfs.h>
const char *explain_statvfs(const char *pathname, struct statvfs *data);
const char *explain_errno_statvfs(int errnum, const char *pathname,
struct statvfs *data);
void explain_message_statvfs(char *message, int message_size, const char
*pathname, struct statvfs *data);
void explain_message_errno_statvfs(char *message, int message_size, int
errnum, const char *pathname, struct statvfs *data);

🌸 DESCRIPTION 🌸

So the whole vibe here? These functions hand you explanations for errors that come back from the statvfs(2) system call. Not me reading manpages for fun but honestly? Obsessed. 🫢


πŸŽ€ explain_statvfs

const char *explain_statvfs(const char *pathname, struct statvfs *data);

The explain_statvfs function is your go-to for getting an explanation of an error that statvfs(2) returned. The least the message will contain is the value of strerror(errno), but usually it will do much better and tell you the underlying cause in more detail. like, it ate. πŸ”₯

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

  • pathname β€” the original pathname, exactly as passed to the statvfs(2) system call. no edits, no glow-ups, exactly.
  • data β€” the original data, exactly as passed to the statvfs(2) system call. same energy.

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. not me being the bearer of bad news πŸ’€

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

if (statvfs(pathname, data) < 0)
{
    fprintf(stderr, "%s\n", explain_statvfs(pathname, data));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_statvfs_or_die(3) function. ✨


🧚 explain_errno_statvfs

const char *explain_errno_statvfs(int errnum, const char *pathname,
struct statvfs *data);

The explain_errno_statvfs function is used to obtain an explanation of an error returned by the statvfs(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. πŸ’œ

  • 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. so like, grab it early bestie πŸ™ˆ
  • pathname β€” the original pathname, exactly as passed to the statvfs(2) system call.
  • data β€” the original data, exactly as passed to the statvfs(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.

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

if (statvfs(pathname, data) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_statvfs(err, pathname,
    data));
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_statvfs_or_die(3) function.


πŸ“ explain_message_statvfs

void explain_message_statvfs(char *message, int message_size, const char
*pathname, struct statvfs *data);

The explain_message_statvfs function is used to obtain an explanation of an error returned by the statvfs(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.

  • message β€” the location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe. slay πŸ’…
  • message_size β€” the size in bytes of the location in which to store the returned message.
  • pathname β€” the original pathname, exactly as passed to the statvfs(2) system call.
  • data β€” the original data, exactly as passed to the statvfs(2) system call.

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

if (statvfs(pathname, data) < 0)
{
    char message[3000];
    explain_message_statvfs(message, sizeof(message), pathname,
    data);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_statvfs_or_die(3) function.


πŸ‘‘ explain_message_errno_statvfs

void explain_message_errno_statvfs(char *message, int message_size, int
errnum, const char *pathname, struct statvfs *data);

The explain_message_errno_statvfs function is used to obtain an explanation of an error returned by the statvfs(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. main character energy fr fr ✨

  • 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.
  • pathname β€” the original pathname, exactly as passed to the statvfs(2) system call.
  • data β€” the original data, exactly as passed to the statvfs(2) system call.

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

if (statvfs(pathname, data) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_statvfs(message, sizeof(message), err,
    pathname, data);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre‐packaged as the explain_statvfs_or_die(3) function.


πŸ’œ SEE ALSO πŸ’œ

  • statvfs(2) β€” get file system statistics πŸ¦‹
  • explain_statvfs_or_die(3) β€” get file system statistics and report errors πŸ’…

libexplain version 1.4 Copyright (C) 2010 Peter Miller


and that's the whole page bestie, explain_statvfs(3) out πŸ’– this lil corner of the Library Functions Manual is brought to you by libexplain version 1.4 and Copyright (C) 2010 Peter Miller β€” go forth and decode your errnos, mwah πŸŽ€πŸŒΈβœ¨

πŸ“¦ where this page comes from