golang/libnbd-golang.pod

   1 =head1 NAME
   2
   3 libnbd-golang - how to use libnbd from Go
   4
   5 =head1 SYNOPSIS
   6
   7  import "libguestfs.org/libnbd"
   8
   9  h, err := libnbd.Create()
  10  if err != nil {
  11      panic(err)
  12  }
  13  defer h.Close()
  14  uri := "nbd://localhost"
  15  err = h.ConnectUri(uri)
  16  if err != nil {
  17      panic(err)
  18  }
  19  size, err := h.GetSize()
  20  if err != nil {
  21      panic(err)
  22  }
  23  fmt.Printf("size of %s = %d\n", uri, size)
  24
  25 =head1 DESCRIPTION
  26
  27 This manual page documents how to use libnbd to access Network Block
  28 Device (NBD) servers from the Go programming language.  The Go
  29 bindings work very similarly to the C bindings so you should start by
  30 reading L<libnbd(3)>.
  31
  32 =head1 HANDLES
  33
  34 Create a libnbd handle of type C<Libnbd> by calling C<Create()>.
  35
  36 You can either close the handle explicitly by a deferred call to
  37 C<h.Close()> or it will be closed automatically when it is garbage
  38 collected.
  39
  40 =head1 ERRORS
  41
  42 Most calls return either a single C<LibnbdError> or a pair
  43 C<(ret, LibnbdError)>.
  44
  45 =head1 EXAMPLES
  46
  47 This directory contains examples written in Go:
  48
  49 L<https://gitlab.com/nbdkit/libnbd/tree/master/golang/examples>
  50
  51 =head1 SEE ALSO
  52
  53 L<libnbd(3)>.
  54
  55 =head1 AUTHORS
  56
  57 Richard W.M. Jones
  58
  59 =head1 COPYRIGHT
  60
  61 Copyright Red Hat