ost::CommandOptionRest(3)

πŸ“¦ version 1.8.1, in ubuntu jammy

πŸ’– ost::CommandOptionRest(3) πŸ’–

okay bestie, welcome to the Library Functions Manual page for ost::CommandOptionRest β€” yes it's a C++ class from GNU CommonC++, no I will not be normal about it, let's GO πŸ¦‹


✨ NAME ✨

ost::CommandOptionRest β€” it literally only makes sense to have one single one of these set, and it's exclusive with CommandOptionCollect. that's the whole personality. πŸ’…


🌸 SYNOPSIS 🌸

#include <cmdoptns.h>

Inherits ost::CommandOptionWithArg.

πŸŽ€ Public Member Functions πŸŽ€

CommandOptionRest (const char *inOptionName, const char *inOptionLetter,
    const char *inDescription, bool inRequired=false, CommandOption
    **ppNext=&defaultCommandOptionList)
  • the CommandOptionRest contructor. (yes that's how it's spelled in the source, we love a typo that's canon πŸ’€)

🌈 Additional Inherited Members

(they're inherited, they're just vibing up the class hierarchy, go look at the parent if you need them 🫢)


πŸ‘‘ Detailed Description πŸ‘‘

okay so, real talk: it only makes sense to have a single one of these set, and it is exclusive with CommandOptionCollect. one. uno. singular. no cap. 🚫

it is the option that takes the rest of the command line options that are not part of any other options. it's giving "everything else goes in this bucket". for example:

strace -ofile command arg1 arg2

the command arg1 arg2 part is what gets placed in objects of this class. iconic behaviour honestly. ✨

CommandOption to take the rest of the command line

🧚 Examples 🧚

  • cmdlineopt.cpp. β€” go read it bestie, it's the moment πŸ“

πŸ’œ Constructor & Destructor Documentation πŸ’œ

ost::CommandOptionRest::CommandOptionRest (const char * inOptionName, const char * inOptionLetter, const char * inDescription, bool inRequired = false, CommandOption ** ppNext = &defaultCommandOptionList)

CommandOptionRest contructor. this sets the optionType for this object to Trailing. yes, Trailing. it trails. it's a trailer. main character energy at the end of the line. πŸ‘‘

⭐ Parameters ⭐

  • inOptionName β€” the long option name
  • inOptionLetter β€” the short letter name
  • inDescription β€” a short description of the option
  • inRequired β€” true if the option is required
  • ppNext β€” the linked list header

🌷 Author 🌷

generated automatically by Doxygen for GNU CommonC++ from the source code. the robot wrote it, I just did the vibes. πŸ˜­πŸ’–


fr fr, that's the whole page. no options were harmed, none were skipped, we kept every single detail. periodt. πŸ’…

GNU CommonC++ Β· Sun Dec 27 2020 β€” mwah, that's the version and date, love u, bye bestie!! πŸŽ€πŸ¦‹βœ¨πŸ’–πŸŒˆ

πŸ“¦ where this page comes from