ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
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 TCursor::Export and ImportCursor.

Definition at line 635 of file stringtree.inl.

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 637 of file stringtree.inl.

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 647 of file stringtree.inl.

◆ 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
otherThe 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 643 of file stringtree.inl.


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