Strings

This section contains collection support for single byte strings such as char*. More...

Functions
RUAPI ru_uint	ruStrHash (trans_ptr key)
	Returns a hash for given string. More...
RUAPI bool	ruStrMatch (trans_ptr s1, trans_ptr s2)
	Convenience match function for Maps. More...
RUAPI int32_t	ruStrComp (trans_ptr testVal, trans_ptr existingVal)
	String comparator function for the ruType system. More...
RUAPI ruType	ruTypeStrRef (void)
	Returns an ruType used for permanent strings. More...
RUAPI ruType	ruTypeStrDup (void)
	Returns an ruType used for transient strings. More...
RUAPI ruType	ruTypeStrFree (void)
	Returns an ruType used for externally allocated string. More...

Detailed Description

This section contains collection support for single byte strings such as char*.

Function Documentation

ruStrComp()

RUAPI int32_t ruStrComp	(	trans_ptr	testVal,
		trans_ptr	existingVal
	)

String comparator function for the ruType system.

Parameters

testVal	Value to compare against existing value.
existingVal	The 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.

ruStrHash()

RUAPI ru_uint ruStrHash

(

trans_ptr

key

)

Returns a hash for given string.

This function is useful for Maps.

Parameters

key	String to hash.

Returns

The hash of the given string or 0 if NULL was given.

ruStrMatch()

RUAPI bool ruStrMatch	(	trans_ptr	s1,
		trans_ptr	s2
	)

Convenience match function for Maps.

Parameters

s1	First comparison string.
s2	Second comparison string.

Returns

true if ruStrCmp returns 0

ruTypeStrDup()

RUAPI ruType ruTypeStrDup

(

void

)

Returns an ruType used for transient strings.

Example:

// error checking left out for brevity
ruMap rm = ruMapNew(ruTypeStrDup(), ruTypeStrDup());
ruMapPut(rm, "23", "42");
 
perm_chars r = NULL;
ruMapGet(rm, "23", &r);
printf("k: '23' v: %ld\n", r);
ruMapFree(rm);

Given keys will be copied when added and freed on removal or ruMapFree.

Returns

Duplicating string type specification. Caller need not free.

ruTypeStrFree()

RUAPI ruType ruTypeStrFree

(

void

)

Returns an ruType used for externally allocated string.

Example:

// error checking left out for brevity
ruMap rm = ruMapNew(ruTypeStrFree(), ruTypeStrFree());
alloc_chars k = ruStrDup("23");
alloc_chars v = ruStrDup("42");
ruMapPut(rm, k, v);
 
perm_chars r = NULL;
ruMapGet(rm, "23", &r);
printf("k: '23' v: '%s'\n", r);
ruMapFree(rm);

Given keys will not be copied when added but freed on removal or ruMapFree.

Returns

Freeable string type specification. Caller need not free.

ruTypeStrRef()

RUAPI ruType ruTypeStrRef

(

void

)

Returns an ruType used for permanent strings.

Example:

// error checking left out for brevity
perm_chars k1 = "23";
perm_chars v1 = "42";
ruMap rm = ruMapNew(ruTypeStrRef(), ruTypeStrRef());
ruMapPut(rm, k1, v1);
 
perm_chars r = NULL;
ruMapGet(rm, "23", &r);
printf("k: '23' v: '%s'\n", r);
ruMapFree(rm);

Given keys will neither be copied nor freed and must exist for the duration of the map using them.

Returns

Permanent string type specification. Caller need not free.