view buf_finish.3 @ 13:3e1c384e0d3f

buf_puts: uses memcpy as it may be optimized
author David Demelier <markand@malikania.fr>
date Sat, 12 Dec 2020 21:50:23 +0100
parents b1991ee4451d
children d87e84936795
line wrap: on
line source

.\"
.\" buf_finish.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_FINISH 3
.Os
.\" NAME
.Sh NAME
.Nm buf_finish
.Nd clear the buffer and free resources
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft void
.Fn buf_finish "struct buf *b"
.\" DESCRIPTION
.Sh DESCRIPTION
Free the internal resources and reset the buffer state specified by
.Fa b .
.Pp
The buffer may be freely reused after calling the
.Fn buf_finish
function, it is also safe to call the function on a finalized buffer as well.
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3 ,
.Xr buf_clear
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>