llarp::config

Classes

	Name
struct	llarp::config::ClientOnly_t
struct	llarp::config::Comment Adds one or more comment lines to the option definition.
struct	llarp::config::Default Wrapper to specify a default value to an OptionDefinition.
struct	llarp::config::Deprecated_t
struct	llarp::config::Env Fetches config from environmental variable.
struct	llarp::config::Hidden_t
struct	llarp::config::MultiValue_t
struct	llarp::config::option_flag
struct	llarp::config::RelayOnly_t
struct	llarp::config::Required_t

Types

	Name
template <typename T > using std::remove_cv_t< std::remove_reference_t< T > >	remove_cvref_t

Functions

	Name
template <typename T > auto	AssignmentAcceptor(T & ref) A convenience function that returns an acceptor which assigns to a reference.

Attributes

	Name
constexpr Required_t	Required Value to pass for an OptionDefinition to indicate that the option is required.
constexpr Hidden_t	Hidden Value to pass for an OptionDefinition to indicate that the option should be hidden from the generate config file if it is unset (and has no comment).
constexpr MultiValue_t	MultiValue Value to pass for an OptionDefinition to indicate that the option takes multiple values.
constexpr RelayOnly_t	RelayOnly Value to pass for an option that should only be set for relay configs.
constexpr ClientOnly_t	ClientOnly Value to pass for an option that should only be set for client configs.
constexpr Deprecated_t	Deprecated Value to pass for an option that is deprecated and does nothing and should be ignored (with a deprecation warning) if specified.
constexpr bool	is_default
constexpr bool	is_default< Default< T > >
constexpr bool	is_default< U & >
constexpr bool	is_default_array
constexpr bool	is_default_array< U & >
constexpr bool	is_env_v
constexpr bool	is_option

Types Documentation

using remove_cvref_t

template <typename T >
using llarp::config::remove_cvref_t = typedef std::remove_cv_t<std::remove_reference_t<T> >;

Functions Documentation

function AssignmentAcceptor

template <typename T >
auto AssignmentAcceptor(
    T & ref
)

A convenience function that returns an acceptor which assigns to a reference.

Note that this holds on to the reference; it must only be used when this is safe to do. In particular, a reference to a local variable may be problematic.

Attributes Documentation

variable Required

constexpr Required_t Required {};

Value to pass for an OptionDefinition to indicate that the option is required.

variable Hidden

constexpr Hidden_t Hidden {};

Value to pass for an OptionDefinition to indicate that the option should be hidden from the generate config file if it is unset (and has no comment).

Typically for deprecated, renamed options that still do something, and for internal dev options that aren't usefully exposed. (For do-nothing deprecated options use Deprecated instead).

variable MultiValue

constexpr MultiValue_t MultiValue {};

Value to pass for an OptionDefinition to indicate that the option takes multiple values.

variable RelayOnly

constexpr RelayOnly_t RelayOnly {};

Value to pass for an option that should only be set for relay configs.

If found in a client config it be ignored (but will produce a warning).

variable ClientOnly

constexpr ClientOnly_t ClientOnly {};

Value to pass for an option that should only be set for client configs.

If found in a relay config it will be ignored (but will produce a warning).

variable Deprecated

constexpr Deprecated_t Deprecated {};

Value to pass for an option that is deprecated and does nothing and should be ignored (with a deprecation warning) if specified.

Note that Deprecated implies Hidden, and that {client,relay}-only options in a {relay,client} config are also considered Deprecated.

variable is_default

constexpr bool is_default = false;

variable is_default< Default< T > >

constexpr bool is_default< Default< T > > = true;

variable is_default< U & >

constexpr bool is_default< U & > = is_default<remove_cvref_t<U>>;

variable is_default_array

constexpr bool is_default_array = false;

variable is_default_array< U & >

constexpr bool is_default_array< U & > = is_default_array<remove_cvref_t<U>>;

variable is_env_v

constexpr bool is_env_v = std::is_same_v<Env, remove_cvref_t<T>>;

variable is_option

constexpr bool is_option = std::is_base_of_v<option_flag, remove_cvref_t<Option>>
        or std::is_same_v<Comment, Option> or is_default<Option> or is_default_array<Option>
        or std::is_invocable_v<remove_cvref_t<Option>, T> or is_env_v<Option>;

---

Updated on 2026-01-10 at 22:49:45 +0000