regify utility  2.0.0-0

This section contains collection support for 8 Bit Integers such as int8_t. More...

Functions

RUAPI ru_uint ruInt8Hash (trans_ptr key)
 Returns a hash for given 8 bit integer number. More...
 
RUAPI bool ruInt8Match (trans_ptr testKey, trans_ptr existingKey)
 Convenience 8 bit integer match function for Maps. More...
 
RUAPI int32_t ruInt8Comp (trans_ptr testVal, trans_ptr existingVal)
 8 bit integer comparator function for the ruType system More...
 
RUAPI ptr ruInt8RefPtr (ptr in)
 Returns the content of the given 8 bit integer address as pointer. More...
 
RUAPI int32_t ruRefPtrInt8 (ptr src, ptr *dst)
 Copies the 8 bit integer stored in src to dst. More...
 
RUAPI ruType ruTypeInt8 (void)
 Returns an ruType used for 8 bit integers. More...
 

Detailed Description

This section contains collection support for 8 Bit Integers such as int8_t.

Function Documentation

◆ ruInt8Comp()

RUAPI int32_t ruInt8Comp ( trans_ptr  testVal,
trans_ptr  existingVal 
)

8 bit integer comparator function for the ruType system

Parameters
testValValue to compare against existing value.
existingValThe existing value to compare testVal to.
Returns
-1 if testVal is less existingVal, 1 if testVal is greater existingVal or 0 in case both of them are equal.

◆ ruInt8Hash()

RUAPI ru_uint ruInt8Hash ( trans_ptr  key)

Returns a hash for given 8 bit integer number.

Parameters
keyNumber to hash
Returns
The hash of the given number.

◆ ruInt8Match()

RUAPI bool ruInt8Match ( trans_ptr  testKey,
trans_ptr  existingKey 
)

Convenience 8 bit integer match function for Maps.

Parameters
testKeyFirst comparison int.
existingKeySecond comparison int.
Returns
true if they are equal

◆ ruInt8RefPtr()

RUAPI ptr ruInt8RefPtr ( ptr  in)

Returns the content of the given 8 bit integer address as pointer.

Parameters
inaddress to 8 bit integer
Returns
content of given address in pointer sized field

◆ ruRefPtrInt8()

RUAPI int32_t ruRefPtrInt8 ( ptr  src,
ptr dst 
)

Copies the 8 bit integer stored in src to dst.

Parameters
srcWhere the 8 bit integer is stored, usually in the collection.
dstWhere the value will be copied to properly type casted.
Returns
RUE_OK unless dst is not set.

◆ ruTypeInt8()

RUAPI ruType ruTypeInt8 ( void  )

Returns an ruType used for 8 bit integers.

Returns
8 bit integer type specification. Caller need not free.