Pebble Foundation Classes  0.2.0
C++ for Pebble
Tuplet Struct Reference

#include <pebble.h>

Public Attributes

TupleType type
 
uint32_t key
 The key.
 
union {
   struct {
      const uint8_t *   data
 Pointer to the data.
 
      const uint16_t   length
 Length of the data.
 
   }   bytes
 Valid when .type. is TUPLE_BYTE_ARRAY.
 
   struct {
      const char *   data
 Pointer to the c-string data.
 
      const uint16_t   length
 Length of the c-string, including terminating zero.
 
   }   cstring
 Valid when .type. is TUPLE_CSTRING.
 
   struct {
      uint32_t   storage
 
      const uint16_t   width
 Width of the integer.
 
   }   integer
 Valid when .type. is TUPLE_INT or TUPLE_UINT.
 
}; 
 See documentation of .bytes, .cstring and .integer fields. More...
 
union {
   struct {
      const uint8_t *   data
 Pointer to the data.
 
      const uint16_t   length
 Length of the data.
 
   }   bytes
 Valid when .type. is TUPLE_BYTE_ARRAY.
 
   struct {
      const char *   data
 Pointer to the c-string data.
 
      const uint16_t   length
 Length of the c-string, including terminating zero.
 
   }   cstring
 Valid when .type. is TUPLE_CSTRING.
 
   struct {
      uint32_t   storage
 
      const uint16_t   width
 Width of the integer.
 
   }   integer
 Valid when .type. is TUPLE_INT or TUPLE_UINT.
 
}; 
 See documentation of .bytes, .cstring and .integer fields. More...
 

Detailed Description

Non-serialized, template data structure for a key/value pair. For strings and byte arrays, it only has a pointer to the actual data. For integers, it provides storage for integers up to 32-bits wide. The Tuplet data structure is useful when creating dictionaries from values that are already stored in arbitrary buffers. See also Tuple, with is the header of a serialized key/value pair.

Member Data Documentation

◆ @1

union { ... }

See documentation of .bytes, .cstring and .integer fields.

Anonymous union containing the reference to the Tuplet's value, being either a byte array, c-string or integer. See documentation of .bytes, .cstring and .integer fields.

◆ @16

union { ... }

See documentation of .bytes, .cstring and .integer fields.

Anonymous union containing the reference to the Tuplet's value, being either a byte array, c-string or integer. See documentation of .bytes, .cstring and .integer fields.

◆ length

const uint16_t Tuplet::length

Length of the data.

Length of the c-string, including terminating zero.

◆ storage

uint32_t Tuplet::storage

Actual storage of the integer. The signedness can be derived from the .type value.

◆ type

TupleType Tuplet::type

The type of the Tuplet. This determines which of the struct fields in the anonymomous union are valid.


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