sds_bptree_instance(3)

🌸 NAME 🌸

okay bestie, welcome to sds_bptree_instance(3) — the Library Functions Manual page for sds_bptree_instance. It’s giving “the B+Tree instance struct,” and we’re gonna go through every single field, no cap. 💅

---

✨ SYNOPSIS ✨

#include <sds.h>

🎀 Data Fields 🎀

uint32_t checksum
uint16_t offline_checksumming
uint16_t search_checksumming
uint16_t print_iter
sds_bptree_node * root
void(* value_free_fn )(void *value)
void *(* value_dup_fn )(void *value)
int64_t(* key_cmp_fn )(void *a, void *b)
void(* key_free_fn )(void *key)
void *(* key_dup_fn )(void *key)

---

💖 Detailed Description 💖

This is the instance of the B+Tree. It stores references to function pointers for manipulation of keys and values within the tree. It also maintains the root checksum, which establishes the “root of trust” to all other nodes in the tree. 🫶

---

🔍 Field Documentation 🔍

💅 uint32_t sds_bptree_instance::checksum

Checksum of the instance data. Literally the vibe check for the instance itself. ✨

🌸 int64_t(* sds_bptree_instance::key_cmp_fn) (void *a, void *b)

Key comparison function. This must return an int64_t of the difference in the values.

• A result of < 0 indicates that a is less than b.
• A result of 0 indicates that the values of a and b are identical.
• A result of > 0 indicates that a is greater than b.

🦋 void *(* sds_bptree_instance::key_dup_fn) (void *key)

Key duplication function. This duplicates the value of key and returns a new pointer to it.

bestie, this is used extensively in the tree structure, and the key or result may be freed out of order — so don’t blindly return the same data. 😭

🎀 void(* sds_bptree_instance::key_free_fn) (void *key)

Key free function. This must free the pointer provided by key. 🧚

⭐ uint16_t sds_bptree_instance::offline_checksumming

This flag determines if we maintain and update checksum values during tree operations, and that we verify these during the verification operation. 👑

💜 uint16_t sds_bptree_instance::print_iter

Internal tracking id for tree display. It’s the little backstage pass for showing the tree. 🎟️

🌈 sds_bptree_node* sds_bptree_instance::root

Pointer to the current tree root node. The main character of the tree, fr fr. 🌳

🔥 uint16_t sds_bptree_instance::search_checksumming

This flag determines if we verify all checksums during the read and write paths of the code.

Adds a large performance overhead, but guarantees the data in the tree is “consistent”. So yeah — expensive, but iconic for safety. 💀✨

🍓 void *(* sds_bptree_instance::value_dup_fn) (void *value)

This function should be able to duplicate value of the type that will be inserted into the tree.

Values may be freed and duplicated in an order you do not expect, so blindly returning a pointer to the same data may not be wise if free then destroys it. iykyk. 🙈

🧚 void(* sds_bptree_instance::value_free_fn) (void *value)

This function should be able to free values of the type that will be inserted into the tree. 🫶

---

👑 Author 👑

Generated automatically by Doxygen for dirsrv from the source code.

---

okay that’s the whole page, bestie 💅 — source/version at the bottom: dirsrv, Version 3.3.0. The footer doesn’t show a separate date, so I’m not inventing one. periodt. 🫶✨