Welcome to little lamb

Code » limb » master » tree

[master] / src / doc / bytestr.h / byte_str.3.md 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% limb manual
% byte_str(3)
% limb 0.2.0
% 2024-01-09

# NAME

byte_str byte_istr - locate a byte array within another byte array

# SYNOPSIS

    #include <limb/bytestr.h>

```pre hl
size_t byte_str(const char *<em>haystack</em>, size_t <em>hlen</em>, const char *<em>needle</em>, size_t <em>nlen</em>)
size_t byte_istr(const char *<em>haystack</em>, size_t <em>hlen</em>, const char *<em>needle</em>, size_t <em>nlen</em>)
```

# DESCRIPTION

The `byte_str`() function looks for the first occurrence of the byte array
`needle` of length `nlen` in the byte array `haystack` of length `hlen`.

Neither `haystack` nor `needle` need be NUL-terminated, and in fact can contain
themselves bytes of any value.

The `byte_istr`() function is similar but performing case-insensitive
comparisons for the current locale. (Specifically, it relies on [tolower](3).)

! WARNING:
! Unless both arrays are small, the `byte_istr`() function will perform poorly.

# RETURN VALUE

The `byte_str`() and `byte_istr`() functions return the offset of the first
occurrence of `needle` within `haystack` if found. Otherwise, they returns
`hlen`.