KJSON_PUTNULL(3)

💜 KJSON_PUTNULL(3) 💜

okay so bestie, this is a page from the Library Functions Manual — yes, the real one — and it's all about kjson_putnull and kjson_putnullp from the libkcgijson library. sit down, grab a lil snack 🍓, we're learning today.

---

✨ NAME ✨

kjson_putnull, kjson_putnullp — the girlies that put null content for kcgijson. that's it. that's the job. 💅

---

📚 LIBRARY 📚

library “libkcgijson” — that's the one, that's the icon 👑

---

🎀 SYNOPSIS 🎀

like, the whole vibe, verbatim:

#include <sys/types.h>
#include <stdarg.h>
#include <stdint.h>
#include <kcgi.h>
#include <kcgijson.h>

enum kcgi_err
kjson_putnull(struct kjsonreq *req);

enum kcgi_err
kjson_putnullp(struct kjsonreq *req, const char *name);

---

🦋 DESCRIPTION 🦋

so the way this works: you write a null to a context req that was initialised with khtml_open(3). yes, khtml_open(3) — that's not a typo, that's what the page says, don't come for me 🙈

• the kjson_putnull() form is for array scopes, periodt
• the kjson_putnullp() form is for objects 💖

and here's the lil gotcha: if you pass a NULL value to name for kjson_putnullp(), that's equivalent to just calling kjson_putnull(). same energy, different name tag 🫶

---

🔥 RETURN VALUES 🔥

returns an enum kcgi_err telling you the error state. let's do a vibe check on each one:

• KCGI_OK — success, we ate, this is not an error 💅✨
• KCGI_ENOMEM — internal memory allocation failure 😭 the memory said no
• KCGI_HUP — the output connection has been terminated. for FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. she's gone, bestie 💀
• KCGI_FORM — the connection is still expecting headers with khttp_head(3). this means khttp_body(3) did not return with success or was not invoked. for FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. lowkey awkward ngl
• KCGI_SYSTEM — internal system error writing to the output stream. the system is being messy 😤
• KCGI_WRITER — the incorrect form was used for the current scope. like, for example, an array-type write within an object. wrong place, wrong time, wrong scope — read the room 🙈

---

🌈 EXAMPLES 🌈

the following outputs a simple JSON document. it assumes r is a struct kreq pointer. and for brevity — and because we're being cute and casual — it does not do any error checking. no cap, live dangerously 💀

khttp_head(r, kresps[KRESP_STATUS],
  "%s", khttps[KHTTP_200]);
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
  "%s", kmimetypes[KMIME_APP_JSON]);
khttp_body(r);
kjson_open(&req, r);
kjson_obj_open(&req);
kjson_putnullp(&req, "bar");
kjson_close(&req);

look at her go. iconic. "bar" gets a null and honestly? she earned it 👑

---

🧚 SEE ALSO 🧚

• kcgijson(3) — go read it, iykyk

---

🌸 AUTHORS 🌸

written by Kristaps Dzonsons <kristaps@bsd.lv>. we stan a legend 🫶

---

and that's the whole page, bestie 💖 this little cutie came from Debian, version stamp $Mdocdate$, and she lives at KJSON_PUTNULL(3). mwah, go write some JSON ✨🎀