Value Tuples (Typed Arrays?)
[State Utility Library]

Typedefs
typedef sul_tuple_value_t	sul_tuple_value_t
typedef sul_tuple_t	sul_tuple_t
Functions
	sul_tuple_create (apr_pool_t *pool)
	sul_tuple_create_picklev (apr_pool_t *pool, const char *f, va_list var_args)
	sul_tuple_create_pickle (apr_pool_t *pool, const char *f,...)
	sul_tuple_picklev (sul_tuple_t *tuple, const char *f, va_list var_args)
	sul_tuple_pickle (sul_tuple_t *tuple, const char *f,...)
	sul_tuple_unpackpv (apr_pool_t *pool, sul_tuple_t *tuple, va_list var_args)
	sul_tuple_unpackp (apr_pool_t *pool, sul_tuple_t *tuple,...)
	sul_tuple_unpackv (sul_tuple_t *tuple, va_list var_args)
	sul_tuple_unpack (sul_tuple_t *tuple,...)
	sul_tuple_value_append (sul_tuple_t *tuple, sul_tuple_value_t *tv)
	sul_tuple_value_create (char type, apr_pool_t *pool)
	sul_tuple_head (sul_tuple_t *tuple)
	sul_tuple_size (sul_tuple_t *tuple)
	sul_tuplen (sul_tuple_value_t *tv)
	sul_tuple_value_type (sul_tuple_value_t *tv)
	sul_tuple_value_unpack (sul_tuple_value_t *tv, void *value)

---

Typedef Documentation

typedef struct sul_tuple_t sul_tuple_t

Opaque data structure representing a Tuple.

typedef struct sul_tuple_value_t sul_tuple_value_t

Opaque data structure that Wraps a value stored inside of a Tuple.

---

Function Documentation

sul_tuple_create (  apr_pool_t *  pool  )

Creates a Tuple object, allocating from pool. This tuple is an empty one and has a size of exactly zero. Parameters: pool  Pool to allocate overhead from. Returns: A new Tuple.

sul_tuple_create_pickle (  apr_pool_t *  pool, const char *  f, ...  )

Creates a Tuple object that contains a set of data matching the types f and pulling from the variadic data. Parameters: pool  Pool to allocate overhead from. f  String describing the types of the objects being placed in this Tuple from var_args. Returns: A new Tuple.

sul_tuple_create_picklev (  apr_pool_t *  pool, const char *  f, va_list  var_args )

Creates a Tuple object that contains a set of data matching the types f and pulling from var_args. Parameters: pool  Pool to allocate overhead from. f  String describing the types of the objects being placed in this Tuple from var_args. var_args  Variadic arguments to pull the tuple items from. Returns: A new Tuple.

sul_tuple_head (  sul_tuple_t *  tuple  )

Gets the Tuple Value that is first in this Tuple. Internally the tuple is stored as a linked list of tuple values. Iteration can be accomplished by first getting the tuple head using sul_tuple_head and then using this function to move through them. Parameters: tuple  A Tuple. Returns: A Tuple Value.

sul_tuple_pickle (  sul_tuple_t *  tuple, const char *  f, ...  )

Adds data to a Tuple. Parameters: tuple  A tuple. f  Types of the arguments contained in the Tuple.

sul_tuple_picklev (  sul_tuple_t *  tuple, const char *  f, va_list  var_args )

Adds data to a Tuple. Parameters: tuple  A tuple. f  Types of the arguments contained in the Tuple. var_args  Variadic args with the data.

sul_tuple_size (  sul_tuple_t *  tuple  )

Gets the size of a Tuple, the number of Tuple Values it contains. Parameters: tuple  A Tuple. Returns: The size of the Tuple.

sul_tuple_unpack (  sul_tuple_t *  tuple, ...  )

Extracts the data from a Tuple. Parameters: tuple  A tuple. Returns: FALSE if something bad happened.

sul_tuple_unpackp (  apr_pool_t *  pool, sul_tuple_t *  tuple, ...  )

Extracts the data from a Tuple. Parameters: pool  Pool to allocate memory overhead for the unpack from. tuple  A tuple. Returns: FALSE if something bad happened.

sul_tuple_unpackpv (  apr_pool_t *  pool, sul_tuple_t *  tuple, va_list  var_args )

Extracts the data from a Tuple. Parameters: pool  Pool to allocate memory overhead for the unpack from. tuple  A tuple. var_args  Variadic args with the data. Returns: FALSE if something bad happened.

sul_tuple_unpackv (  sul_tuple_t *  tuple, va_list  var_args )

Extracts the data from a Tuple. Parameters: tuple  A tuple. var_args  Variadic args with the data. Returns: FALSE if something bad happened.

sul_tuple_value_append (  sul_tuple_t *  tuple, sul_tuple_value_t *  tv )

Adds a new tuple value to a Tuple. Parameters: tuple  A tuple. tv  A tuple value.

sul_tuple_value_create (  char  type, apr_pool_t *  pool )

Creates a new Tuple Value. Parameters: type  Type of the tuple value. pool  Pool to allocate overhead from. Returns: A new tuple value.

sul_tuple_value_type (  sul_tuple_value_t *  tv  )

Gets the Type of a specific Tuple Value. See the documentation for Tuple's for more details on which character refers to which type. Parameters: tv  A Tuple Value. Returns: Type specifier for the Tuple Value.

sul_tuple_value_unpack (  sul_tuple_value_t *  tv, void *  value )

Unpacks the value of a Tuple Value into the given variable. Parameters: tv  A Tuple Value. value  Pointer to receive the Tuple's value. Returns: TRUE on success and FALSE otherwise.

sul_tuplen (  sul_tuple_value_t *  tv  )

Gets the Tuple Value that is after this one in a linked list. Internally the tuple is stored as a linked list of tuple values. Iteration can be accomplished by first getting the tuple head using sul_tuple_head and then using this function to move through them. Parameters: tv  A Tuple Value. Returns: A Tuple Value.

---