KJSON_PUTSTRING(3)

💖 KJSON_PUTSTRING(3) — put string content for kcgijson 💖

okay so bestie, welcome to KJSON_PUTSTRING(3) from the Library Functions Manual, we're literally about to make JSON strings happen and it's gonna be adorable. this is kjson_putstring, kjson_putstringp, and kjson_string_puts, all chillin' together in one page 🎀

---

🌸 LIBRARY 🌸

lowkey important: these live in the library “libkcgijson”. that's the vibe. that's the home. 🏠✨

---

✨ SYNOPSIS ✨

like, here's the whole cast, in code, exactly as written because i would never mess with a synopsis:

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

enum kcgi_err
kjson_putstring(struct kjsonreq *req, const char *v);

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

enum kcgi_err
kjson_string_puts(struct kjsonreq *req, const char *v);

three functions, one header stack, zero drama. slay 💅

---

🦋 DESCRIPTION 🦋

so what do they do? they write a string v to a context req that was initialised with khtml_open(3). that's the whole assignment. 💖

and here's a cute little detail: if v is NULL, these do nothing and return KCGI_OK. no crash, no tantrum, just vibes. 🧘‍♀️

which one do you use? depends on the scope, bestie:

• kjson_putstring() — for array scopes 🌈
• kjson_putstringp() — for objects 👑
• kjson_string_puts() — for open strings 🎀

and the safety feature?? all values are JSON escaped so that content cannot prematurely end its context. literally not me being protected from my own string content 😭🔥

also, passing a NULL value to name for kjson_putstringp() is equivalent to calling kjson_putstring(). same thing, different door. iykyk 🚪✨

---

💜 RETURN VALUES 💜

returns an enum kcgi_err indicating the error state. so like, it's always telling you how it's feeling. let's go through the whole mood ring:

• KCGI_OK — success (not an error). we love a happy ending 💚
• KCGI_ENOMEM — internal memory allocation failure. the malloc said no 💀
• KCGI_HUP — the output connection has been terminated. and for FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. so, cleanup era 🧹
• KCGI_FORM — the connection is still expecting headers with khttp_head(3). this indicates that khttp_body(3) did not return with success or was not invoked. and again, for FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. same energy, different error 🙈
• KCGI_SYSTEM — internal system error writing to the output stream. oop 💀
• KCGI_WRITER — the incorrect form was used for the current scope, for example, an array-type write within an object. yeah that's a vibe check fail, bestie 🚫

---

⭐ EXAMPLES ⭐

here's the flex: this outputs a simple JSON document. it assumes r is a struct kreq pointer. and for brevity, it does not do any error checking (bold of it, honestly 💅).

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_putstringp(&req, "bar", "shbar");
kjson_arrayp_open(&req, "baz");
kjson_putstring(&req, "xyzzy"));
kjson_close(&req);

look at that little JSON being born 🥹 it's giving main character energy fr fr 🌟

---

🫶 SEE ALSO 🫶

• kcgijson(3) — go read the whole family, bestie, they're iconic 👑

---

🌈 AUTHORS 🌈

written by Kristaps Dzonsons <kristaps@bsd.lv>. absolute legend, no cap. 🫡💖

---

aaaaand that's the page!! this lil' manual page landed via Debian, dated $Mdocdate$, and it's literally titled KJSON_PUTSTRING(3) — so go forth, escape those strings, respect the scope, and stan KCGI_OK forever 🎀💜✨