util::config::Array Class Reference

Array definition to store multiple values provided by the user from Json/Yaml. More...

#include <Array.hpp>

Public Member Functions
	Array (ConfigValue arg)
	Constructs an Array with provided Arg.
std::optional< Error >	addValue (Value value, std::optional< std::string_view > key=std::nullopt)
	Add ConfigValues to Array class.
std::optional< Error >	addNull (std::optional< std::string_view > key=std::nullopt)
	Add null value to the array.
size_t	size () const
	Returns the number of values stored in the Array.
ConfigValue const &	at (std::size_t idx) const
	Returns the ConfigValue at the specified index.
ConfigValue const &	getArrayPattern () const
	Returns the ConfigValue that defines the type/constraint every ConfigValue must follow in Array.
std::vector< ConfigValue >::const_iterator	begin () const
	Returns an iterator to the beginning of the ConfigValue vector.
std::vector< ConfigValue >::const_iterator	end () const
	Returns an iterator to the end of the ConfigValue vector.

Static Public Member Functions
static std::string_view	prefix (std::string_view key)
	Extract array prefix from a key, For example for a key foo.[].bar the method will return foo.[].

Detailed Description

Array definition to store multiple values provided by the user from Json/Yaml.

Used in ClioConfigDefinition to represent multiple potential values (like whitelist) Is constructed with only 1 element which states which type/constraint must every element In the array satisfy

Constructor & Destructor Documentation

Array()

util::config::Array::Array

(

ConfigValue

arg

)

Constructs an Array with provided Arg.

Parameters

arg	Argument to set the type and constraint of ConfigValues in Array

Member Function Documentation

addNull()

std::optional< Error > util::config::Array::addNull ( std::optional< std::string_view > key = std::nullopt )

nodiscard

Add null value to the array.

Note

The error will be returned if item pattern of the array is neither optional nor has a default value

Parameters

key	An optional key which will be used for error message only (if any)

Returns

An error if any or nullopt if the operation succeeded

addValue()

std::optional< Error > util::config::Array::addValue ( Value value, std::optional< std::string_view > key = std::nullopt )

nodiscard

Add ConfigValues to Array class.

Parameters

value	The ConfigValue to add
key	optional string key to include that will show in error message

Returns

optional error if adding config value to array fails. nullopt otherwise

at()

ConfigValue const & util::config::Array::at ( std::size_t idx ) const

nodiscard

Returns the ConfigValue at the specified index.

Parameters

idx	Index of the ConfigValue to retrieve

Returns

ConfigValue at the specified index

begin()

std::vector< ConfigValue >::const_iterator util::config::Array::begin ( ) const

nodiscard

Returns an iterator to the beginning of the ConfigValue vector.

Returns

A constant iterator to the beginning of the vector.

end()

std::vector< ConfigValue >::const_iterator util::config::Array::end ( ) const

nodiscard

Returns an iterator to the end of the ConfigValue vector.

Returns

A constant iterator to the end of the vector.

getArrayPattern()

ConfigValue const & util::config::Array::getArrayPattern ( ) const

nodiscard

Returns the ConfigValue that defines the type/constraint every ConfigValue must follow in Array.

Returns

The item_pattern

prefix()

std::string_view util::config::Array::prefix ( std::string_view key )

static

Extract array prefix from a key, For example for a key foo.[].bar the method will return foo.[].

Note

Provided key must contain '.[]'

Warning

Be careful with string_view! Returned value is valid only while the key is valid

Parameters

key	The key to extract the array prefix from

Returns

Prefix of array extracted from the key

size()

size_t util::config::Array::size ( ) const

nodiscard

Returns the number of values stored in the Array.

Returns

Number of values stored in the Array

---

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

• /__w/clio/clio/src/util/config/Array.hpp
• /__w/clio/clio/src/util/config/Array.cpp