.\"
.\" buf_erase.3 -- simple string buffer for C
.\"
.\" Copyright (c) 2019-2022 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-2022
.Dt BUF_ERASE 3
.Os
.\" NAME
.Sh NAME
.Nm buf_erase
.Nd erase a portion of the string
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft void
.Fn buf_erase "struct buf *b" "size_t pos" "size_t count"
.\" DESCRIPTION
.Sh DESCRIPTION
Remove
.Fa count
number of character in the buffer specified by
.Fa b
starting at
.Fa pos .
.Pp
It is possible to pass -1 as
.Fa count
parameter to remove the remaining text until the end of the string.
.Pp
Undefined behavior may occur if the
.Fa pos
argument is outside of the buffer bounds.
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>