annotate buf_sub.3 @ 19:cf6a2b8642c1

misc: added tag 0.2.0 for changeset 7f5b3f035bef
author David Demelier <markand@malikania.fr>
date Wed, 16 Dec 2020 16:20:43 +0100
parents b1991ee4451d
children 939fe74cd80a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" buf_sub.3 -- simple string buffer for C
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" Permission to use, copy, modify, and/or distribute this software for any
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\" purpose with or without fee is hereby granted, provided that the above
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" copyright notice and this permission notice appear in all copies.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Dd October 29, 2019-2020
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Dt BUF_SUB 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Os
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .\" NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Nm buf_sub
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Nd duplicate a specific portion from the buffer
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .\" SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Sh SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .In buf.h
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Ft bool
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fn buf_sub "struct buf *b" "const struct buf *src" "size_t pos" "size_t count"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .\" DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Sh DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Extract the portion at position
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Fa pos
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 from the buffer specified by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Fa src
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 with
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Fa count
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 number of characters and set to
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Fa b .
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 This function will first initialize and allocate the buffer specified by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Fa b
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 to fill the portion length.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 It should not contain any data because it will be overwritten.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .Fa count
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 argument can be set to -1 to extract data until the end of the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Fa src
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 buffer.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 Undefined behavior may occur if the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Fa pos
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 argument is outside of the buffer bounds.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .\" RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Sh RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Fn buf_sub
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 function returns false in case of error and
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Va errno
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 is set to indicate the error.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .\" ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .Sh ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Bl -tag -width Er
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .It Bq Er ENOMEM
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 Memory allocation failed.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .El
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .\" SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Sh SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .Xr libbuf 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .\" AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Sh AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Nm libbuf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 library was written by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .An David Demelier <markand@malikania.fr>