Union value type#

group Union value type

A generic union value type.

Defines

jsdrv_union_null()#

jsdrv_union_null_r()#

jsdrv_union_f32(_value)#

jsdrv_union_f32_r(_value)#

jsdrv_union_f64(_value)#

jsdrv_union_f64_r(_value)#

jsdrv_union_u8(_value)#

jsdrv_union_u8_r(_value)#

jsdrv_union_u16(_value)#

jsdrv_union_u16_r(_value)#

jsdrv_union_u32(_value)#

jsdrv_union_u32_r(_value)#

jsdrv_union_u64(_value)#

jsdrv_union_u64_r(_value)#

jsdrv_union_i8(_value)#

jsdrv_union_i8_r(_value)#

jsdrv_union_i16(_value)#

jsdrv_union_i16_r(_value)#

jsdrv_union_i32(_value)#

jsdrv_union_i32_r(_value)#

jsdrv_union_i64(_value)#

jsdrv_union_i64_r(_value)#

jsdrv_union_str(_value)#

jsdrv_union_cstr(_value)#

jsdrv_union_cstr_r(_value)#

jsdrv_union_json(_value)#

jsdrv_union_cjson(_value)#

jsdrv_union_cjson_r(_value)#

jsdrv_union_bin(_value, _size)#

jsdrv_union_cbin(_value, _size)#

jsdrv_union_cbin_r(_value, _size)#

Enums

enum jsdrv_union_e#

The allowed data types.

Values:

enumerator JSDRV_UNION_NULL#: NULL value. Also used to clear existing value.

enumerator JSDRV_UNION_STR#: UTF-8 string value, null terminated.

enumerator JSDRV_UNION_JSON#: UTF-8 JSON string value, null terminated.

enumerator JSDRV_UNION_BIN#: Raw binary value.

enumerator JSDRV_UNION_STDMSG#: mb_stdmsg_s constant binary message, see mb/stdmsg.h

enumerator JSDRV_UNION_FRAME#: Comm frame binary message, see doc/comm/frame.md and mb/comm/frame.h.

enumerator JSDRV_UNION_F32#: 32-bit IEEE 754 floating point

enumerator JSDRV_UNION_F64#: 64-bit IEEE 754 floating point

enumerator JSDRV_UNION_U8#: Unsigned 8-bit integer value.

enumerator JSDRV_UNION_U16#: Unsigned 16-bit integer value.

enumerator JSDRV_UNION_U32#: Unsigned 32-bit integer value.

enumerator JSDRV_UNION_U64#: Unsigned 64-bit integer value.

enumerator JSDRV_UNION_I8#: Signed 8-bit integer value.

enumerator JSDRV_UNION_I16#: Signed 16-bit integer value.

enumerator JSDRV_UNION_I32#: Signed 32-bit integer value.

enumerator JSDRV_UNION_I64#: Signed 64-bit integer value.

enum jsdrv_union_flag_e#

The standardized Joulescope driver union flags.

Applications may define custom flags in jsdrv_union_s.app.

Values:

enumerator JSDRV_UNION_FLAG_NONE#: No flags specified.

enumerator JSDRV_UNION_FLAG_RETAIN#: The PubSub instance should retain this value.

enumerator JSDRV_UNION_FLAG_CONST#: The value points to a const that will remain valid indefinitely.

enumerator JSDRV_UNION_FLAG_HEAP_MEMORY#: The value uses dynamically allocated heap memory that must be freed.

Functions

bool jsdrv_union_eq(const struct jsdrv_union_s *v1, const struct jsdrv_union_s *v2)#

Check if two values are equal.

This check only compares the type and value. The types and values must match exactly. However, it ignores the additional fields [flags, op, app]. Use jsdrv_union_eq_exact() to also compare these fields. Use jsdrv_union_equiv() to more loosely check the value.

Parameters:

v1 – The first value.
v2 – The second value.

Returns:

True if equal, false if not equal.

bool jsdrv_union_eq_exact(const struct jsdrv_union_s *v1, const struct jsdrv_union_s *v2)#

Check if two values are equal.

This check strictly compares every field.

Parameters:

v1 – The first value.
v2 – The second value.

Returns:

True if equal, false if not equal.

bool jsdrv_union_equiv(const struct jsdrv_union_s *v1, const struct jsdrv_union_s *v2)#

Check if two values are equivalent.

This check performs type up-conversions to attempt to match the two fields.

Parameters:

v1 – The first value.
v2 – The second value.

Returns:

True if equal, false if not equal.

void jsdrv_union_widen(struct jsdrv_union_s *x)#

Widen to the largest-size, compatible numeric type.

This widening conversion preserves float, signed, and unsigned characteristics. Float types are widened to f64, signed integer types to i64, and unsigned integer types to u64. Pointer types (string, JSON, binary) are unchanged.