rux::database::PathComponent Struct Reference

Represents a single component in a resource path. More...

#include <path_parser.hpp>

Collaboration diagram for rux::database::PathComponent:

Public Member Functions
	PathComponent (ComponentType t, std::string v)
	PathComponent (ComponentType t, std::string v, int idx)
bool	is_collection () const
bool	is_item () const
bool	is_property () const
bool	is_index () const
bool	has_wildcard () const

Public Attributes
ComponentType	type
std::string	value
std::optional< int >	index

Detailed Description

Represents a single component in a resource path.

Examples:

• clouds → {Collection, "clouds"}
• mycloud → {Item, "mycloud"}
• metadata → {Property, "metadata"}
• [0] → {Index, "", 0}

Definition at line 43 of file path_parser.hpp.

Constructor & Destructor Documentation

PathComponent() [1/2]

rux::database::PathComponent::PathComponent ( ComponentType t, std::string v )

inline

Definition at line 48 of file path_parser.hpp.

References index, type, and value.

PathComponent() [2/2]

rux::database::PathComponent::PathComponent ( ComponentType t, std::string v, int idx )

inline

Definition at line 51 of file path_parser.hpp.

References index, type, and value.

Member Function Documentation

has_wildcard()

bool rux::database::PathComponent::has_wildcard ( ) const

inline

Definition at line 58 of file path_parser.hpp.

References value.

is_collection()

bool rux::database::PathComponent::is_collection ( ) const

inline

Definition at line 54 of file path_parser.hpp.

References rux::database::Collection, and type.

is_index()

bool rux::database::PathComponent::is_index ( ) const

inline

Definition at line 57 of file path_parser.hpp.

References rux::database::Index, and type.

is_item()

bool rux::database::PathComponent::is_item ( ) const

inline

Definition at line 55 of file path_parser.hpp.

References rux::database::Item, and type.

is_property()

bool rux::database::PathComponent::is_property ( ) const

inline

Definition at line 56 of file path_parser.hpp.

References rux::database::Property, and type.

Member Data Documentation

index

std::optional<int> rux::database::PathComponent::index

Definition at line 46 of file path_parser.hpp.

Referenced by PathComponent(), and PathComponent().

type

ComponentType rux::database::PathComponent::type

Definition at line 44 of file path_parser.hpp.

Referenced by is_collection(), is_index(), is_item(), is_property(), PathComponent(), and PathComponent().

value

std::string rux::database::PathComponent::value

Definition at line 45 of file path_parser.hpp.

Referenced by has_wildcard(), PathComponent(), and PathComponent().

---

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

• apps/rux/include/database/path_parser.hpp