xref: /freebsd/lib/libutil++/freebsd__nvlist_up.3 (revision 159503125826bc2d3b988921e7e85735ee09ad46)
1*15950312SJohn Baldwin.\"
2*15950312SJohn Baldwin.\" SPDX-License-Identifier: BSD-2-Clause
3*15950312SJohn Baldwin.\"
4*15950312SJohn Baldwin.\" Copyright (c) 2025 Chelsio Communications, Inc.
5*15950312SJohn Baldwin.\" Written by: John Baldwin <jhb@FreeBSD.org>
6*15950312SJohn Baldwin.\"
7*15950312SJohn Baldwin.Dd July 31, 2025
8*15950312SJohn Baldwin.Dt FREEBSD::NVLIST_UP 3
9*15950312SJohn Baldwin.Os
10*15950312SJohn Baldwin.Sh NAME
11*15950312SJohn Baldwin.Nm freebsd::nvlist_up
12*15950312SJohn Baldwin.Nd std::unique_ptr specialization for name/value pairs
13*15950312SJohn Baldwin.Sh LIBRARY
14*15950312SJohn Baldwin.Lb libutil++
15*15950312SJohn Baldwin.Sh SYNOPSIS
16*15950312SJohn Baldwin.In libutil++.hh
17*15950312SJohn Baldwin.Ft using nvlist_up = std::unique_ptr<nvlist, nvlist_deleter>;
18*15950312SJohn Baldwin.Sh DESCRIPTION
19*15950312SJohn BaldwinThis class is a specialization of
20*15950312SJohn Baldwin.Vt std::unique_ptr
21*15950312SJohn Baldwinfor
22*15950312SJohn Baldwin.Vt nvlist_t
23*15950312SJohn Baldwinobjects.
24*15950312SJohn BaldwinWhen an
25*15950312SJohn Baldwin.Vt nvlist_t
26*15950312SJohn Baldwinobject managed by an instance of this class is disposed,
27*15950312SJohn Baldwin.Xr nvlist_destroy 3
28*15950312SJohn Baldwinis invoked to dispose of the object.
29*15950312SJohn Baldwin.Sh EXAMPLES
30*15950312SJohn Baldwin.Bd -literal -offset indent
31*15950312SJohn Baldwinfreebsd::nvlist_up nvl(nvlist_create(0));
32*15950312SJohn Baldwinnvlist_add_number(nvl.get(), "answer", 42);
33*15950312SJohn Baldwinnvlist_add_bool(nvl.get(), "valid", true);
34*15950312SJohn Baldwin// `nvl' is implicitly destroyed
35*15950312SJohn Baldwin.Ed
36*15950312SJohn Baldwin.Sh SEE ALSO
37*15950312SJohn Baldwin.Xr nvlist_destroy 3
38