.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.20.0 (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-rust 3"
.TH libnbd-rust 3 2024-05-31 libnbd-1.20.0 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\-rust \- how to use libnbd from Rust
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& let nbd = libnbd::Handle::new().unwrap();
\& nbd.connect_uri("nbd://localhost").unwrap();
\& let size = nbd.get_size().unwrap();
\& println!("{size} bytes");
.Ve
.PP
In \f(CW\*(C`Cargo.toml\*(C'\fR add:
.PP
.Vb 2
\& [dependencies]
\& libnbd = VERSION | { path = "libnbd/rust" }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This manual page documents how to use libnbd to access Network Block
Device (NBD) servers from the Rust programming language.
.PP
The Rust bindings work very similarly to the C bindings so you should
start by reading \fBlibnbd\fR\|(3).
.PP
There is also a higher level asynchronous API using Tokio.
.PP
If you build libnbd from source, the main documentation can be found
in \fIlibnbd/rust/target/doc/libnbd/index.html\fR
.PP
For the ordinary interface, start by reading the documentation for
\&\f(CW\*(C`Handle\*(C'\fR.  For the higher level asynchronous API, start by reading
\&\f(CW\*(C`AsyncHandle\*(C'\fR.
.PP
\&\f(CW\*(C`libnbd\-sys\*(C'\fR is a very low level wrapper around the libnbd API which
should not be used directly.
.SH EXAMPLES
.IX Header "EXAMPLES"
This directory contains examples written in Rust:
.PP
https://gitlab.com/nbdkit/libnbd/tree/master/rust/examples
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
Tage Johansson
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Tage Johansson
.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