Pigweed
C/C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
pw::kvs::KeyValueStore::Item Class Reference

Representation of a key-value entry during iteration. More...

Public Member Functions

const char * key () const
 
StatusWithSize Get (span< std::byte > value_buffer, size_t offset_bytes=0) const
 
template<typename Pointer , typename = std::enable_if_t<std::is_pointer<Pointer>::value>>
Status Get (const Pointer &pointer) const
 
StatusWithSize ValueSize () const
 

Friends

class iterator
 

Detailed Description

Representation of a key-value entry during iteration.

Member Function Documentation

◆ Get()

StatusWithSize pw::kvs::KeyValueStore::Item::Get ( span< std::byte >  value_buffer,
size_t  offset_bytes = 0 
) const
inline
Returns
The value referred to by this iterator. Equivalent to pw::kvs::KeyValueStore::Get().

◆ key()

const char * pw::kvs::KeyValueStore::Item::key ( ) const
inline
Returns
The key as a null-terminated string.

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