NAME

byte_get_match_full, byte_get_match - find the (partial) match of a given string in an array

SYNOPSIS

#include <limb/bytestr.h>

int byte_get_match_full(int *first, const char *str, size_t slen,
                        const void *list, size_t offset, size_t llen)
int byte_get_match(int *first, const char *str, size_t slen, const char **list)

DESCRIPTION

The byte_get_match_full() function looks inside the array list for a string matching str of length slen.

Each element of the array list must by llen bytes long, and must contain, at byte offset (starting from 0), a pointer to a NUL-terminated string to check against.

An element is said to match if its slen first bytes are the same as those from str. In case of an exact match, that is the element's NUL-terminated string is of length slen, the search ends and the function returns.

If the element's string is longer however, the search continues through the remaining elements in list. No other elements shall match for a success. Otherwise -1 is returned, and if first is not NULL the value it points to is set to the index of the first-matching element.

The search goes on until an exact match is found, or an element is found with a string pointer that is NULL.

The byte_get_match() function is similar, but simply takes list as a NULL terminated array of NUL-terminated string pointers.

RETURN VALUE

These functions return the index of the matching element in list, or -1 if either no element matched str, or more than one did. In the later case, if first was not NULL the value it points to is set to the index of the first-matching element.

EXAMPLE

Usually you'll probably want to use byte_get_match() with a NULL terminated array of strings.

An example of use for byte_get_match_full() would be when the strings are members of a structure, e.g:

1
2
3
4
5
6
7

cstruct user {
  int id;
  const char *name;
} users[];

int r = byte_get_match_full(&first, name, strlen(name), users,
                            offsetof(struct user, name), sizeof(*users));

SEE ALSO

list_matches_full(3)