explain_acl_from_text(3)

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

🌸 NAME 🌸

okay so bestie, welcome to explain_acl_from_text(3) πŸ’– β€” straight out of the Library Functions Manual. This page is literally just here to explain acl_from_text(3) errors, no cap. That's the whole job. That's the whole vibe.


✨ SYNOPSIS ✨

#include <libexplain/acl_from_text.h>
const char *explain_acl_from_text(const char *text);
const char *explain_errno_acl_from_text(int errnum, const char *text);
void explain_message_acl_from_text(char *message, int message_size,
const char *text);
void explain_message_errno_acl_from_text(char *message, int
message_size, int errnum, const char *text);

like. four whole functions. four little besties. each one does the same emotional labor but with slightly different trust issues (buffers, errno, etc.) 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea: these functions may be used to obtain explanations for errors returned by the acl_from_text(3) system call. That's it. That's their entire personality. error translator era ✨


πŸŽ€ explain_acl_from_text πŸŽ€

const char *explain_acl_from_text(const char *text);

The explain_acl_from_text function is used to obtain an explanation of an error returned by the acl_from_text(3) 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. it's giving overachiever πŸ’…

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

  • text β€” the original text, exactly as passed to the acl_from_text(3) system call. exactly. don't be cute with it, don't trim it, just pass it through πŸ™ˆ

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. bestie please, i am begging you, do not take this into a thread. she will not survive 😭

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

acl_t result = acl_from_text(text);
if (result < 0)
{
    fprintf(stderr, "%s\n", explain_acl_from_text(text));
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_from_text_or_die(3) function. pre-packaged?? we love convenience πŸ‘‘


πŸ’œ explain_errno_acl_from_text πŸ’œ

const char *explain_errno_acl_from_text(int errnum, const char *text);

The explain_errno_acl_from_text function is used to obtain an explanation of an error returned by the acl_from_text(3) 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. same energy, extra parameter 🧚

  • 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. like ma'am, errno is not a stable queen, she changes πŸ’€
  • text β€” the original text, exactly as passed to the acl_from_text(3) 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:

acl_t result = acl_from_text(text);
if (result < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_acl_from_text(err,
    text));
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_from_text_or_die(3) function.


🌈 explain_message_acl_from_text 🌈

void explain_message_acl_from_text(char *message, int message_size,
const char *text);

The explain_message_acl_from_text function is used to obtain an explanation of an error returned by the acl_from_text(3) 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. now with a buffer you own, main character energy honestly πŸ‘‘

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. oh she's responsible. she has her own room. love that for her 🫢
  • message_size β€” the size in bytes of the location in which to store the returned message.
  • text β€” the original text, exactly as passed to the acl_from_text(3) system call.

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

acl_t result = acl_from_text(text);
if (result < 0)
{
    char message[3000];
    explain_message_acl_from_text(message, sizeof(message),
    text);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_from_text_or_die(3) function.


⭐ explain_message_errno_acl_from_text ⭐

void explain_message_errno_acl_from_text(char *message, int
message_size, int errnum, const char *text);

The explain_message_errno_acl_from_text function is used to obtain an explanation of an error returned by the acl_from_text(3) 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 final boss form. thread safe AND errno safe. iconic behavior, no notes πŸ”₯

  • 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.
  • text β€” the original text, exactly as passed to the acl_from_text(3) system call.

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

acl_t result = acl_from_text(text);
if (result < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_acl_from_text(message, sizeof(message),
    err, text);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre-packaged as the explain_acl_from_text_or_die(3) function.


πŸ“ SEE ALSO πŸ“


libexplain version 1.4 Copyright (C) 2013 Peter Miller


aaaand that's the whole page bestie, tysm for reading πŸ₯ΊπŸ’– this little legend came to you from libexplain version 1.4, dated 2013, and yes it lives in the Library Functions Manual. go forth and explain those errors. periodt. πŸ‘‘πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from