Welcome to little lamb

Code » limb » master » tree

[master] / src / doc / buffer.h / buffer_len.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
38
% limb manual
% buffer_len(3)
% limb 0.1.0
% 2023-07-24

# NAME

buffer_len, buffer_getlen - get used/available length of an I/O buffer

# SYNOPSIS

    #include <limb/buffer.h>

```pre hl
size_t buffer_len(buffer *<em>buf</em>)
size_t buffer_getlen(buffer *<em>buf</em>)

size_t buffer_available(buffer *<em>buf</em>)
```

# DESCRIPTION

The `buffer_len`() macro returns the amount of data currently in the internal
memory of the buffer pointed by `buf`, i.e. either read or not yet flushed to
its associated file descriptor.

The `buffer_getlen`() function is similar, but as a function.

The `buffer_available`() macro returns the amount of space available in the
internal memory of the buffer pointed by `buf`.

# RETURN VALUE

The `buffer_len`() and `buffer_getlen`() functions return the amount of data
currently in the buffer pointed by `buf`.

The `buffer_available`() macro returns the amount of space available in the
internal memory of the buffer pointed by `buf`.