nbdkit_export_name(3)

📦
version 1.48.1 · 10 versions
, in fedora 44

💖 nbdkit_export_name 💖

okay bestie, so this is nbdkit_export_name(3), a lil page from the NBDKIT manual. it's giving "one tiny function, huge main character energy" and honestly? we're obsessed. let's get into it 🦋

✨ NAME ✨

nbdkit_export_name — get the NBD export name for nbdkit. that's it. that's the whole job. slay.

🌸 SYNOPSIS 🌸

like, the actual signature, no cap:

#include <nbdkit-plugin.h>

const char *nbdkit_export_name (void);

🎀 DESCRIPTION 🎀

so what it does is: it returns the optional NBD export name, but only if one was actually negotiated with the current client. and the way it pulls this off? thread-local magic ✨ so you don't even have to pass a parameter. iconic behaviour, truly.

the export name is a free-form text string, bestie. it is not necessarily a path or a filename, and it does not need to begin with a '/' character. like, don't assume. the NBD protocol describes the empty string ("") as representing a "default export", or as the thing you use when the export name doesn't even make sense.

⚠️ okay this part matters, listen up: the export name is untrusted client data. be cautious when parsing it. like, do not just trust it, fr fr. 🚨

💅 RETURN VALUE 💅

the function returns a string. the returned string is valid at least through the .close of the current connection — but if you need to store it in the plugin so it can be used by more than one client, you must copy it. no shortcuts, bestie, that pointer will betray you.

if there's an error, it calls nbdkit_error(3) and returns NULL. 😭

🌈 LANGUAGE BINDINGS 🌈

she's multilingual, she's global, she's everywhere 💅

🐫 In nbdkit-ocaml-plugin(3):

NBDKit.export_name : unit -> string

🐍 In nbdkit-python-plugin(3):

import nbdkit
name = nbdkit.export_name()

🦀 In nbdkit-rust-plugin(3):

use nbdkit::*;
pub fn export_name() -> std::result::Result<String, Box<dyn error::Error>>

🐚 In nbdkit-sh-plugin(3):

the export name is available as parameter $3 of the "open" method. yes, just $3. go get her.

🕰️ HISTORY 🕰️

"nbdkit_export_name" was added in nbdkit 1.16. a classic. a legend. an era. ⭐

👀 SEE ALSO 👀

go read these too, they're all part of the friend group:

👑 AUTHORS 👑

Richard W.M. Jones 💖

Copyright Red Hat

📜 LICENSE 📜

okay so legally speaking, redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
🫶 and now the scary part, in all caps because it means business: THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page, bestie!! 🌈✨ this lil legend is from nbdkit-1.48.1, dated 2026-08-29 — mwah, go forth and parse responsibly 💖🎀🦋

📦 where this page comes from