LUA-URI-DATA(3)

LUA-URI-DATA 💅✨

okay bestie, this is the lua-uri-data page from the Lua uri.data module — yes it's a real manual page, yes I read all of it, and yes I'm gonna make it make sense. sit down, grab a strawberry 🍓, we're doing this.

---

NAME 🎀

lua-uri-data — it's the whole data URI support situation for the Lua URI library. that's it. that's the name.

---

DESCRIPTION 🦋

so the class uri.data is the one you use for URIs that have the data scheme. it's a subclass situation — it inherits from the uri class, so all that energy is in its bloodline. 👑

some of the features in this module need the lua-datafilter(3) library to be installed first. but — and this is important, bestie — you can still create URI objects from data URIs even if lua-datafilter(3) isn't there. so it's not a hard requirement, just a "some things hit different when it's installed" thing. 🫶

now the vibe check on validity, because this class is picky and honestly? fair:

• any data URI that contains an authority part is considered invalid. no authority. not allowed. periodt. 💀
• also invalid: any URI whose path does not contain a comma. the comma is not optional, she's the main character. 😤
• and if the URI has the ;base64 parameter, then the data must consist only of characters that are allowed in base64 encoded data. that means: upper and lowercase ASCII letters, digits, and the forward slash and plus characters. that's the whole guest list, nobody else gets in. ✨

---

METHODS 🌸

every single method defined in lua-uri(3) is supported here. full inheritance, she got it from her mama. 💖

but there are three that act a little special:

• userinfo — always returns nil. and if you pass it anything that isn't nil, it will throw an exception. it does not want your input bestie. 🙈
• host — same deal. always returns nil, throws an exception when passed anything other than nil.
• port — you already know. always nil, and throws an exception if you pass anything other than nil.

and the path method? she'll throw an exception if you give her a new path that is nil or that isn't valid for the data scheme. so like... bring her something valid or don't bring her anything at all. 💅

the following extra methods are also supported:

uri:data_bytes(...) 🧚

get or set the actual data stored in the URI. when you call it, the existing data gets decoded and handed back to you. if you supply a new value it must be a string, and it'll cause the path of the URI to be changed so it encodes that new data. 💫

the method is gonna pick whichever encoding results in the smallest URI — efficiency queen, we love her — unless the datafilter module isn't installed, in which case it will always just use percent encoding. no datafilter, no choices. 🤷♀️

warning bestie: an exception is thrown if the datafilter module is not installed and the data in the URI is encoded as base64. but — a data URI using percent encoding will not cause an exception. so percent encoding is the safe one when datafilter is MIA. 🌈

one more thing: the data you pass in and the data you get back should not be encoded in any special way. the library handles all of that for you, that's literally her job. 😌

uri:data_media_type(...) 🎀

get or set the media type (aka the MIME type) that's stored in the URI's path, before the comma. and heads up: this should not include the ;base64 parameter, because that one gets included in the path automatically whenever it's appropriate. she handles it, don't worry about it. ✨

if there's no media type given in the URI at all, then the default value of text/plain gets returned. and if there's no charset parameter given, then the default ;charset=US-ASCII will be included. defaults on defaults, she's generous like that. 💜

and yes, the media type is encoded and decoded automatically by this method. you don't lift a finger. 🫶

---

REFERENCES ⭐

this class is based on RFC 2397. that's the source material, the blueprint, the original slay. 🔥

---

okay that's the whole page bestie, you ate that 💅✨ version 1.1, dated 2012-00-00, from the Lua uri.data module — go forth and encode responsibly, ily 🦋🌸💖