libnbd-rust3

Usage

 let nbd = libnbd::Handle::new().unwrap();
 nbd.connect_uri("nbd://localhost").unwrap();
 let size = nbd.get_size().unwrap();
 println!("{size} bytes");

 [dependencies]
 libnbd = VERSION | { path = "libnbd/rust" }

Overview

This manual page documents how to use libnbd to access Network Block Device (NBD) servers from the Rust programming language.

The Rust bindings work very similarly to the C bindings so you should start by reading libnbd(3).

There is also a higher level asynchronous API using Tokio.

If you build libnbd from source, the main documentation can be found in libnbd/rust/target/doc/libnbd/index.html

For the ordinary interface, start by reading the documentation for "Handle". For the higher level asynchronous API, start by reading "AsyncHandle".

"libnbd-sys" is a very low level wrapper around the libnbd API which should not be used directly.

Examples

This directory contains examples written in Rust:

https://gitlab.com/nbdkit/libnbd/tree/master/rust/examples