ham::key Class Reference

#include <hamsterdb.hpp>

Public Member Functions
	key (void *data=0, ham_size_t size=0, ham_u32_t flags=0)
	key (const key &other)
key &	operator= (const key &other)
void *	get_data () const
void	set_data (void *data)
ham_size_t	get_size () const
void	set_size (ham_size_t size)
ham_u32_t	get_flags () const
void	set_flags (ham_u32_t flags)
ham_key_t *	get_handle ()
Private Attributes
ham_key_t	m_key

---

Detailed Description

A key class.

This class wraps structures of type ham_key_t.

Definition at line 79 of file hamsterdb.hpp.

---

Constructor & Destructor Documentation

ham::key::key	(	void *	data = 0,
		ham_size_t	size = 0,
		ham_u32_t	flags = 0
	)			[inline]

Constructor

Definition at line 82 of file hamsterdb.hpp.

References ham_key_t::data, ham_key_t::flags, m_key, and ham_key_t::size.

ham::key::key

(

const key &

other

)

[inline]

Copy constructor.

Definition at line 90 of file hamsterdb.hpp.

---

Member Function Documentation

key& ham::key::operator=

(

const key &

other

)

[inline]

Assignment operator.

Definition at line 94 of file hamsterdb.hpp.

References m_key.

void* ham::key::get_data

(

)

const [inline]

Returns the key data.

Definition at line 100 of file hamsterdb.hpp.

References ham_key_t::data, and m_key.

void ham::key::set_data

(

void *

data

)

[inline]

Sets the key data.

Definition at line 105 of file hamsterdb.hpp.

References ham_key_t::data, and m_key.

ham_size_t ham::key::get_size

(

)

const [inline]

Returns the size of the key.

Definition at line 110 of file hamsterdb.hpp.

References m_key, and ham_key_t::size.

void ham::key::set_size

(

ham_size_t

size

)

[inline]

Sets the size of the key.

Definition at line 115 of file hamsterdb.hpp.

References m_key, and ham_key_t::size.

ham_u32_t ham::key::get_flags

(

)

const [inline]

Returns the flags of the key.

Definition at line 120 of file hamsterdb.hpp.

References ham_key_t::flags, and m_key.

void ham::key::set_flags

(

ham_u32_t

flags

)

[inline]

Sets the flags of the key.

Definition at line 125 of file hamsterdb.hpp.

References ham_key_t::flags, and m_key.

ham_key_t* ham::key::get_handle

(

)

[inline]

Returns a pointer to the internal ham_key_t structure.

Definition at line 130 of file hamsterdb.hpp.

References m_key.

Referenced by ham::db::erase(), ham::cursor::find(), ham::db::find(), ham::cursor::insert(), ham::db::insert(), and ham::cursor::move().

---

Field Documentation

ham_key_t ham::key::m_key [private]

Definition at line 135 of file hamsterdb.hpp.

Referenced by get_data(), get_flags(), get_handle(), get_size(), key(), operator=(), set_data(), set_flags(), and set_size().

---

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

• include/ham/hamsterdb.hpp