StormByte::Config::Item::Group Class Reference

Represents a group in a configuration file that can hold other items, subgroups, and sublists recursively. More...

#include <group.hxx>

Inheritance diagram for StormByte::Config::Item::Group:

Collaboration diagram for StormByte::Config::Item::Group:

Public Member Functions
	Group ()=default
	Constructs an empty Group.
	Group (const std::string &name)
	Constructs a Group with the given name.
	Group (std::string &&name)
	Constructs a Group with the given name.
	Group (const Group &group)=default
	Group (Group &&group) noexcept=default
Group &	operator= (const Group &group)=default
Group &	operator= (Group &&group) noexcept=default
	~Group () noexcept override=default
PointerType	Clone () const override
PointerType	Move () override
constexpr Item::ContainerType	ContainerType () const noexcept override
Public Member Functions inherited from StormByte::Config::Item::Container
	Container ()=default
	Constructs an empty Container.
	Container (const std::string &name)
	Container (std::string &&name)
	Container (const Container &base)=default
	Container (Container &&base) noexcept=default
Container &	operator= (const Container &base)=default
Container &	operator= (Container &&base) noexcept=default
virtual	~Container () noexcept override=default
Base &	operator[] (const size_t &index)
const Base &	operator[] (const size_t &index) const
Base &	operator[] (const std::string &path)
const Base &	operator[] (const std::string &path) const
bool	operator== (const Container &container) const noexcept
bool	operator!= (const Container &container) const noexcept
Base &	Add (const Base &item, const OnExistingAction &on_existing=OnExistingAction::ThrowException)
Base &	Add (Base &&item, const OnExistingAction &on_existing=OnExistingAction::ThrowException)
Base &	Add (Base::PointerType item, const OnExistingAction &on_existing)
	Adds an item to the container.
void	Clear () noexcept
bool	Exists (const std::string &path) const
void	Remove (const size_t &index)
void	Remove (const std::string &path)
std::string	Serialize (const int &indent_level) const noexcept override
constexpr std::span< Base::PointerType >	Items () noexcept
constexpr std::span< const Base::PointerType >	Items () const noexcept
constexpr std::string	ContainerTypeToString () const noexcept
constexpr Item::Type	Type () const noexcept override
constexpr size_t	Size () const noexcept
size_t	Count () const noexcept
Public Member Functions inherited from StormByte::Config::Item::Base
	Base ()=default
	Constructs a Base item with an optional name.
	Base (const std::string &name)
	Constructs a Base item with an optional name.
	Base (const Base &base)=default
	Base (Base &&base) noexcept=default
Base &	operator= (const Base &base)=default
Base &	operator= (Base &&base) noexcept=default
virtual	~Base () noexcept=default
bool	operator== (const Base &base) const noexcept
bool	operator!= (const Base &base) const noexcept
constexpr const std::optional< std::string > &	Name () const noexcept
	Gets the name of the item.
constexpr void	Name (const std::string &name) noexcept
bool	IsNameValid () const noexcept
constexpr std::string	TypeToString () const noexcept
	operator std::string () const
template<typename T >
const T &	Value () const
template<typename T >
T &	Value ()

Additional Inherited Members
Static Public Member Functions inherited from StormByte::Config::Item::Container
static constexpr std::pair< const char, const char >	EnclosureCharacters (const ContainerType &type) noexcept
static constexpr const char	EndCharacter (const ContainerType &type) noexcept
Protected Attributes inherited from StormByte::Config::Item::Container
std::vector< Base::PointerType >	m_items
	Items in container.
Protected Attributes inherited from StormByte::Config::Item::Base
std::optional< std::string >	m_name
	Item name.

Detailed Description

Represents a group in a configuration file that can hold other items, subgroups, and sublists recursively.

settings = {
    username = "StormByte"
    credit = 66.5
}

Constructor & Destructor Documentation

Group() [1/4]

StormByte::Config::Item::Group::Group

(

const std::string &

name

)

Constructs a Group with the given name.

Parameters

name	The name of the group.

Group() [2/4]

StormByte::Config::Item::Group::Group

(

std::string &&

name

)

Constructs a Group with the given name.

Parameters

name	The name of the group.

Group() [3/4]

StormByte::Config::Item::Group::Group ( const Group &  group )

default

Copy constructor

Parameters

group

group to copy

Group() [4/4]

StormByte::Config::Item::Group::Group ( Group &&  group )

defaultnoexcept

Move constructor

Parameters

group

group to move

~Group()

StormByte::Config::Item::Group::~Group ( )

overridedefaultnoexcept

Destructor

Member Function Documentation

Clone()

PointerType StormByte::Config::Item::Group::Clone ( ) const

inlineoverride

Clones the container

Returns

cloned container

ContainerType()

constexpr Item::ContainerType StormByte::Config::Item::Group::ContainerType ( ) const

inlineconstexproverridevirtualnoexcept

Gets the container type

Returns

Container type

Implements StormByte::Config::Item::Container.

Move()

PointerType StormByte::Config::Item::Group::Move ( )

inlineoverride

Moves the container

Returns

moved container

operator=() [1/2]

Group & StormByte::Config::Item::Group::operator= ( const Group &  group )

default

Assignment operator

Parameters

group

group to copy

operator=() [2/2]

Group & StormByte::Config::Item::Group::operator= ( Group &&  group )

defaultnoexcept

Move assignment operator

Parameters

group

group to move

---

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

• /home/runner/work/StormByte-Config/StormByte-Config/lib/public/StormByte/config/item/group.hxx