Module libc/string
libc/string
Stability: unstable — a raw C binding, not a Yo design. It is the byte-move layer under the containers: `memcpy` / `memmove` / `memset` for `std/collections/array_list`, `memcpy` / `memcmp` for `std/string` and the `std/imm` persistent structures, `strlen` where a `*char` crosses the FFI boundary. Those modules are the supported surface — a caller here is doing untyped pointer work and owns the aliasing and bounds rules C states (`memcpy` on overlapping ranges is undefined; use `memmove`). The `strcpy` / `strcat` family is bound for completeness and should not be used in new code. Additive-by-demand, follows C. — stable modules only change additively; this one may still change.
C11 <string.h> — string and memory functions.
Stability
unstable — a raw C binding, not a Yo design. It is the byte-move layer
under the containers: memcpy / memmove / memset for
std/collections/array_list, memcpy / memcmp for std/string and
the std/imm persistent structures, strlen where a *char crosses
the FFI boundary. Those modules are the supported surface — a caller
here is doing untyped pointer work and owns the aliasing and bounds
rules C states (memcpy on overlapping ranges is undefined; use
memmove). The strcpy / strcat family is bound for completeness and
should not be used in new code. Additive-by-demand, follows C.
Functions
memcpy
function
fn(dest : *(void), src : *(void), n : usize) -> *(void)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(void) | |
src | *(void) | |
n | usize |
Returns: *(void)
memmove
function
fn(dest : *(void), src : *(void), n : usize) -> *(void)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(void) | |
src | *(void) | |
n | usize |
Returns: *(void)
memset
function
fn(s : *(void), c : int, n : usize) -> *(void)
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(void) | |
c | int | |
n | usize |
Returns: *(void)
memcmp
function
fn(s1 : *(void), s2 : *(void), n : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(void) | |
s2 | *(void) | |
n | usize |
Returns: int
memchr
function
fn(s : *(void), c : int, n : usize) -> ?(*(void))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(void) | |
c | int | |
n | usize |
Returns: ?(*(void))
strcpy
function
fn(dest : *(char), src : *(char)) -> *(char)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
src | *(char) |
Returns: *(char)
strncpy
function
fn(dest : *(char), src : *(char), n : usize) -> *(char)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
src | *(char) | |
n | usize |
Returns: *(char)
strcat
function
fn(dest : *(char), src : *(char)) -> *(char)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
src | *(char) |
Returns: *(char)
strncat
function
fn(dest : *(char), src : *(char), n : usize) -> *(char)
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
src | *(char) | |
n | usize |
Returns: *(char)
strcmp
function
fn(s1 : *(char), s2 : *(char)) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(char) | |
s2 | *(char) |
Returns: int
strncmp
function
fn(s1 : *(char), s2 : *(char), n : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(char) | |
s2 | *(char) | |
n | usize |
Returns: int
strcoll
function
fn(s1 : *(char), s2 : *(char)) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(char) | |
s2 | *(char) |
Returns: int
strxfrm
function
fn(dest : *(char), src : *(char), n : usize) -> usize
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
src | *(char) | |
n | usize |
Returns: usize
strchr
function
fn(s : *(char), c : int) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
c | int |
Returns: ?(*(char))
strrchr
function
fn(s : *(char), c : int) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
c | int |
Returns: ?(*(char))
strspn
function
fn(s : *(char), accept : *(char)) -> usize
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
accept | *(char) |
Returns: usize
strcspn
function
fn(s : *(char), reject : *(char)) -> usize
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
reject | *(char) |
Returns: usize
strpbrk
function
fn(s : *(char), accept : *(char)) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
accept | *(char) |
Returns: ?(*(char))
strstr
function
fn(haystack : *(char), needle : *(char)) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
haystack | *(char) | |
needle | *(char) |
Returns: ?(*(char))
strtok
function
fn(s : ?(*(char)), delim : *(char)) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | ?(*(char)) | |
delim | *(char) |
Returns: ?(*(char))
strlen
function
fn(s : *(char)) -> usize
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) |
Returns: usize
strerror
function
fn(errnum : int) -> *(char)
Parameters
| Name | Type | Notes |
|---|---|---|
errnum | int |
Returns: *(char)
strcpy_s
function
fn(dest : *(char), destsz : usize, src : *(char)) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
destsz | usize | |
src | *(char) |
Returns: int
strncpy_s
function
fn(dest : *(char), destsz : usize, src : *(char), count : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
destsz | usize | |
src | *(char) | |
count | usize |
Returns: int
strcat_s
function
fn(dest : *(char), destsz : usize, src : *(char)) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
destsz | usize | |
src | *(char) |
Returns: int
strncat_s
function
fn(dest : *(char), destsz : usize, src : *(char), count : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(char) | |
destsz | usize | |
src | *(char) | |
count | usize |
Returns: int
memcpy_s
function
fn(dest : *(void), destsz : usize, src : *(void), count : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(void) | |
destsz | usize | |
src | *(void) | |
count | usize |
Returns: int
memmove_s
function
fn(dest : *(void), destsz : usize, src : *(void), count : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
dest | *(void) | |
destsz | usize | |
src | *(void) | |
count | usize |
Returns: int
memset_s
function
fn(s : *(void), smax : usize, c : int, n : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(void) | |
smax | usize | |
c | int | |
n | usize |
Returns: int
strnlen_s
function
fn(s : *(char), maxlen : usize) -> usize
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
maxlen | usize |
Returns: usize
strerror_s
function
fn(s : *(char), maxsize : usize, errnum : int) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
maxsize | usize | |
errnum | int |
Returns: int
strtok_s
function
fn(s : ?(*(char)), delim : *(char), ptr : *(?(*(char)))) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | ?(*(char)) | |
delim | *(char) | |
ptr | *(?(*(char))) |
Returns: ?(*(char))
strdup
function
fn(s : *(char)) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) |
Returns: ?(*(char))
strndup
function
fn(s : *(char), n : usize) -> ?(*(char))
Parameters
| Name | Type | Notes |
|---|---|---|
s | *(char) | |
n | usize |
Returns: ?(*(char))
strcasecmp
function
fn(s1 : *(char), s2 : *(char)) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(char) | |
s2 | *(char) |
Returns: int
strncasecmp
function
fn(s1 : *(char), s2 : *(char), n : usize) -> int
Parameters
| Name | Type | Notes |
|---|---|---|
s1 | *(char) | |
s2 | *(char) | |
n | usize |
Returns: int