.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.20.1 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "libnbd-golang 3"
.TH libnbd-golang 3 2024-05-08 libnbd-1.20.1 LIBNBD
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
libnbd\-golang \- how to use libnbd from Go
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& import "libguestfs.org/libnbd"
\&
\& h, err := libnbd.Create()
\& if err != nil {
\&     panic(err)
\& }
\& defer h.Close()
\& uri := "nbd://localhost"
\& err = h.ConnectUri(uri)
\& if err != nil {
\&     panic(err)
\& }
\& size, err := h.GetSize()
\& if err != nil {
\&     panic(err)
\& }
\& fmt.Printf("size of %s = %d\en", uri, size)
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This manual page documents how to use libnbd to access Network Block
Device (NBD) servers from the Go programming language.  The Go
bindings work very similarly to the C bindings so you should start by
reading \fBlibnbd\fR\|(3).
.SH HANDLES
.IX Header "HANDLES"
Create a libnbd handle of type \f(CW\*(C`Libnbd\*(C'\fR by calling \f(CWCreate()\fR.
.PP
You can either close the handle explicitly by a deferred call to
\&\f(CW\*(C`h.Close()\*(C'\fR or it will be closed automatically when it is garbage
collected.
.SH ERRORS
.IX Header "ERRORS"
Most calls return either a single \f(CW\*(C`LibnbdError\*(C'\fR or a pair
\&\f(CW\*(C`(ret, LibnbdError)\*(C'\fR.
.SH EXAMPLES
.IX Header "EXAMPLES"
This directory contains examples written in Go:
.PP
https://gitlab.com/nbdkit/libnbd/tree/master/golang/examples
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.
.PP
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA