view buf_shrink.3 @ 0:b1991ee4451d

misc: initial import
author David Demelier <markand@malikania.fr>
date Thu, 29 Oct 2020 17:24:30 +0100
parents
children 939fe74cd80a
line wrap: on
line source

.\"
.\" buf_shrink.3 -- simple string buffer for C
.\"
.\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
.\"
.\" Permission to use, copy, modify, and/or distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd October 29, 2019-2020
.Dt BUF_SHRINK 3
.Os
.\" NAME
.Sh NAME
.Nm buf_shrink
.Nd reduce the buffer to its minimal requirement
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft bool
.Fn buf_shrink "struct buf *b"
.\" DESCRIPTION
.Sh DESCRIPTION
Reduce the buffer capacity specified by
.Fa b
to reduce memory usage.
.Pp
The
.Fn buf_shrink
function will reduce the buffer capacity to the exact buffer length.
If reallocation of the new memory region failed, the current buffer is kept and
its capacity is unchanged.
As such, it is perfectly safe to ignore the return value unless you really want
to reduce memory consumption
.\" RETURN VALUE
.Sh RETURN VALUE
If the buffer's length is 0, the function simply frees the underlying data and
return true.
.Pp
Otherwise the
.Fn buf_shrink
function returns false in case of error and
.Va errno
is set to indicate the error.
.\" ERRORS
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOMEM
Memory reallocation failed.
.El
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>