Text::...:String(3pm)

💖 Text::PDF::String 💖

okay so bestie, welcome to Text::PDF::String from the User Contributed Perl Documentation ✨. this one is a 3pm page, which means it's a module manual, and it is literally the PDF String type object — plus it's the superclass for all the simple little objects that are basically stringlike (thinking Number, Name, etc.). it's giving foundational. it's giving mother of stringlikes 👑

---

🌸 NAME 🌸

Text::PDF::String — PDF String type objects, and the superclass for simple objects that are basically stringlike (Number, Name, etc.) 🦋

---

✨ METHODS ✨

no cap, it's all methods down here. every single one, let's go 💅

🎀 Text::PDF::String->from_pdf($string)

makes a brand new string object for you (ngl it's not a full object yet, so don't get too excited) out of the string you hand it. the string gets parsed according to the input criteria, and escaping works — yes queen, the escapes are escaping 🌈

🎀 Text::PDF::String->new($string)

same energy, different doorway: builds a new string object (again, not a full object yet) from the string you pass in. parsed per the input criteria, escaping fully working 💖

🎀 $s->convert($str)

hands you back $str, but converted the way the criteria for input from a PDF file say it should be. it's a glow-up, but make it spec-compliant ✨

🎀 $s->val

gives you the value of this string. and the value of this string is… the string itself 🫶 iconic. no notes.

🎀 $->as_pdf

returns the string, formatted for output as PDF for the PDF File object $pdf. and yes bestie, it really is written $->as_pdf in the source — i'm not gaslighting you, that's the actual signature 🙈 keep it exactly like that.

🎀 $s->outobjdeep

outputs the string in PDF format, complete with the necessary conversions. it does the whole deep-output situation so you don't have to 😭

🎀 $s->copy($inpdf, $res, $unique, $outpdf, %opts)

copies an object 🫡. for the actual details you gotta go read Text::PDF::Objind::Copy() — that's where the lore lives. iykyk.

---

💀 friendly reminder bestie: from_pdf and new give you a string object that is not a full object yet. please do not come for me when it doesn't act like a whole entire object. i warned you. periodt.

---

that's the whole page, you ate it, i'm obsessed with you 💜 this page ships as part of perl v5.36.0 and the date stamped on it is 2022-10-22. mwah, bye bestie 🎀🦋✨