arg_router::policy::program_intro_t< S > Class Template Reference

#include <arg_router/policy/program_intro.hpp>

Public Types
using	string_type = S

Public Member Functions
constexpr	program_intro_t ([[maybe_unused]] S str={}) noexcept

Static Public Member Functions
constexpr static std::string_view	program_intro () noexcept

Detailed Description

template<typename S>
class arg_router::policy::program_intro_t< S >

Represents the program introduction.

Used by help nodes to display a brief description about the program.

If using C++17 then use the template variable helper with the S_ macro; for C++20 and higher, use the constructor directly with a compile-time string literal:

constexpr auto a = ar::policy::program_intro<S_("hello")>;
constexpr auto b = ar::policy::program_intro_t{"hello"_S};

Note

Must be greater than one character

Template Parameters

S	Compile-time string

Definition at line 25 of file program_intro.hpp.

Member Typedef Documentation

string_type

template<typename S >

using arg_router::policy::program_intro_t< S >::string_type = S

String type.

Definition at line 29 of file program_intro.hpp.

Constructor & Destructor Documentation

program_intro_t()

template<typename S >

constexpr arg_router::policy::program_intro_t< S >::program_intro_t ( [[maybe_unused] ] S  str = {} )

inlineexplicitconstexprnoexcept

Constructor.

Parameters

str	String instance

Definition at line 35 of file program_intro.hpp.

Member Function Documentation

program_intro()

template<typename S >

constexpr static std::string_view arg_router::policy::program_intro_t< S >::program_intro ( )

inlinestaticconstexprnoexcept

Returns the program name.

Returns

Program name

Definition at line 41 of file program_intro.hpp.

---

The documentation for this class was generated from the following file:

• arg_router/policy/program_intro.hpp