ObjectBox C and C++ API  4.0.3
obx::TreeOptions Class Reference

Structural/behavioral options for a tree passed during tree creation. More...

#include <objectbox.hpp>

Public Member Functions

 TreeOptions ()
 
 TreeOptions (TreeOptions &&source) noexcept
 Move constructor "stealing" the C resource from the source. More...
 
 ~TreeOptions ()
 
 TreeOptions (const TreeOptions &)=delete
 Can't be copied, single owner of C resources is required (to avoid double-free during destruction) More...
 
TreeOptionspathDelimiter (char delimiter)
 Adjusts the path delimiter character, which is by default "/". More...
 
TreeOptionsflags (uint32_t flags)
 Sets the given OBXTreeOptionFlags. Combine multiple flags using bitwise OR. More...
 

Detailed Description

Structural/behavioral options for a tree passed during tree creation.

Constructor & Destructor Documentation

◆ TreeOptions() [1/3]

obx::TreeOptions::TreeOptions ( )
inline

◆ TreeOptions() [2/3]

obx::TreeOptions::TreeOptions ( TreeOptions &&  source)
inlinenoexcept

Move constructor "stealing" the C resource from the source.

◆ ~TreeOptions()

obx::TreeOptions::~TreeOptions ( )
inline

◆ TreeOptions() [3/3]

obx::TreeOptions::TreeOptions ( const TreeOptions )
delete

Can't be copied, single owner of C resources is required (to avoid double-free during destruction)

Member Function Documentation

◆ flags()

TreeOptions& obx::TreeOptions::flags ( uint32_t  flags)
inline

Sets the given OBXTreeOptionFlags. Combine multiple flags using bitwise OR.

◆ pathDelimiter()

TreeOptions& obx::TreeOptions::pathDelimiter ( char  delimiter)
inline

Adjusts the path delimiter character, which is by default "/".