alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::CursorHandle Struct Reference

Description:

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>
struct alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::CursorHandle

A handle type used with methods Export and ImportCursor.

Note

Exported StringTree-cursors are nothing but pointers to the node in the tree. The field value is of type alib::uinteger and hence the size of a pointer. This class has a very relaxed implementation, which is expressed, for example, in the fact that this field is named in lower-case, while still being publicly accessible. The rationale for this exclamation from the naming-rules is that the reservation of a cursor handle should be possible for external code without including any specific header files, by simply reserving an alib::uinteger.
On the other hand, wherever possible, this class and its sibling ConstCursorHandle should be used to make the code better readable. It might happen that this design is changed in the future.

Definition at line 627 of file stringtree.hpp.

#include <stringtree.hpp>

Public Field Index:
uinteger	value
	The encapsulated value.

Public Method Index:
bool	IsValid () const noexcept
bool	operator== (const CursorHandle &other) const noexcept

Field Details:

value

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

uinteger alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::CursorHandle::value

The encapsulated value.

Definition at line 629 of file stringtree.hpp.

Method Details:

IsValid()

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

bool alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::CursorHandle::IsValid ( ) const

inlinenoexcept

Checks if this is a valid handle.

Returns

true if this handle is not nulled.

Definition at line 639 of file stringtree.hpp.

operator==()

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

bool alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::CursorHandle::operator== ( const CursorHandle & other ) const

inlinenoexcept

Comparison operator.

Parameters

other

The cursor handle to compare this handle to.

Returns

true if both handles refer to the same cursor or if both handles are invalid. false otherwise.

Definition at line 635 of file stringtree.hpp.

---

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

• stringtree.hpp