GFS_PIO_WRITE(3)

💖 GFS_PIO_WRITE(3) 💖

okay bestie, so this is a page from the Gfarm manual, section 3 (that's the library-calls section, iykyk), and we're talking about gfs_pio_write — the lil function that sends your bytes off into a file. let's get into it 🫶

✨ NAME ✨

gfs_pio_write — write to a file

like, that's the whole vibe. it writes. to a file. iconic behavior honestly 💅

🌸 SYNOPSIS 🌸

#include <gfarm/gfarm.h>

gfarm_error_t gfs_pio_write(GFS_File gf, const void * buffer, int size,
                            int * np);

🦋 DESCRIPTION 🦋

so here's the tea 🍓 — gfs_pio_write() writes up to size bytes into the file gf, pulling them from the buffer that starts at buffer. (yes, "up to", bestie, don't come for me, that's literally what it says.)

and then it drops the actual number of bytes it wrote into the address that np is pointing at. so you always know exactly how much actually made it. no guessing, no cap. 💯

⭐ RETURN VALUES ⭐

the way that this function can come back with a whole bouquet of results 😭 here's the full roster, every single one:

• GFARM_ERR_NO_ERROR — it ate and left no crumbs. the function finished successfully. 🎀
• GFARM_ERR_OPERATION_NOT_PERMITTED — gf doesn't specify a regular file. so it's giving "not that kind of file, babe." 🙈
• GFARM_ERR_BAD_FILE_DESCRIPTOR — the file descriptor specified by gfp is not valid, or it's not open for writing. either way, red flag, it can't write there. 💀
• GFARM_ERR_NO_SPACE — the file system node has no room to store data. it's full, bestie, there is simply no more room in the inn. 😭
• GFARM_ERR_NO_FILE_SYSTEM_NODE — there's no available file system node at all. nothing to write to, nowhere to go. 🧚
• GFARM_ERR_NO_MEMORY — insufficient memory was available. the brain cell budget ran out. 🫠
• Others — an error happened that's not in the list above. and the reason why? it gets shown to you by gfarm_error_string(3), so go ask that one. 🔍

👑 SEE ALSO 👑

• gfs_pio_create(3)
• gfs_pio_flush(3)
• gfs_pio_open(3)

💜 friendly reminder: this is the Gfarm manual, and this particular page is dated 27 Jun 2010 — a true vintage moment, we love an OG. stay hydrated, close your file descriptors, and slay. periodt. ✨🌈👑