Loading...
Searching...
No Matches
Data Fields | Related Symbols
as_bin Struct Reference

Detailed Description

Represents a bin of a record. Each bin is a (name,value) pair.

Bins of a record should never be directly accessed. The bins should only be modified via as_record functions. The only time an as_bin is directly accessible is during iteration via as_record_iterator, but the as_bin functions should be used to read the values.

Definition at line 79 of file as_bin.h.

#include "as_bin.h"

+ Collaboration diagram for as_bin:

Data Fields

as_bin_name name
 
as_bin_value value
 
as_bin_valuevaluep
 

Related Symbols

(Note that these are not member symbols.)

static char * as_bin_get_name (const as_bin *bin)
 
static as_val_t as_bin_get_type (const as_bin *bin)
 
static as_bin_valueas_bin_get_value (const as_bin *bin)
 

Friends And Related Symbol Documentation

◆ as_bin_get_name()

static char * as_bin_get_name ( const as_bin * bin)
related

Get the name of the bin.

char * name = as_bin_get_name(bin);
static char * as_bin_get_name(const as_bin *bin)
Definition as_bin.h:146
as_bin_name name
Definition as_bin.h:84
Parameters
binThe bin to get the name of.
Returns
The name of the bin.

Definition at line 146 of file as_bin.h.

References name.

◆ as_bin_get_type()

static as_val_t as_bin_get_type ( const as_bin * bin)
related

Get the type for the value of the bin.

uint8_t type
Definition as_proto.h:1
uint8_t as_val_t
Definition as_val.h:32
static as_val_t as_bin_get_type(const as_bin *bin)
Definition as_bin.h:184
Parameters
binThe bin to get value's type.
Returns
The type of the bin's value

Definition at line 184 of file as_bin.h.

References as_val_type, and valuep.

◆ as_bin_get_value()

static as_bin_value * as_bin_get_value ( const as_bin * bin)
related

Get the value of the bin.

static as_bin_value * as_bin_get_value(const as_bin *bin)
Definition as_bin.h:165
Parameters
binThe bin to get the value of.
Returns
The value of the bin.

Definition at line 165 of file as_bin.h.

References valuep.

Field Documentation

◆ name

as_bin_name as_bin::name

Bin name.

Definition at line 84 of file as_bin.h.

◆ value

as_bin_value as_bin::value

Bin value.

Definition at line 89 of file as_bin.h.

◆ valuep

as_bin_value* as_bin::valuep

Bin value pointer. If NULL, then there is no value. It can point to as_bin.value or a different value.

Definition at line 96 of file as_bin.h.


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