tcl::chan::string(n)

✨ tcl::chan::string — the manual, but make it cute ✨

okay so bestie, welcome to tcl::chan::string(n), part of the Reflected/virtual channel support corner of tcllib. sit down, grab a boba, we're building channels that live entirely in your RAM 💖

---

🌸 NAME 🌸

tcl::chan::string — a read-only, in-memory channel. yeah. it's giving ✨immutable✨ and we're obsessed.

---

🎀 SYNOPSIS 🎀

package require Tcl 8.5 9

package require TclOO

package require tcl::chan::events ?1.1?

package require tcl::chan::string ?1.0.4?

::tcl::chan::string content

---

🦋 DESCRIPTION 🦋

so the tcl::chan::string package hands you a command that makes channels which live purely in memory. no disk, no filesystem, no drama. they give you random-access, which is just the fancy way of saying they're seekable — you can jump around inside them however you want 🔥

but here's the plot twist, bestie: unlike the channels that tcl::chan::memchan makes, these ones are read-only. the content gets handed over at construction time and then it is immutable afterward. periodt. no editing, no rewriting, no take-backs. what you get is what you get 💅

the related packages in this little friend group are tcl::chan::memchan and tcl::chan::variable — go say hi 🫶

and the tea about the internals: the TclOO class doing all the actual channel-handler work is a sub-class of the tcl::chan::events framework. iykyk 😌

---

👑 API 👑

• ::tcl::chan::string content — this is the one and only command, and she's the main character fr fr. she creates a brand new string channel and hands you back its handle. that channel gives you random read-only access to the content string. that's it. that's the whole vibe ✨

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. it's not a vibe, it's just reality 😭 please report them in the virtchannel category of the Tcllib Trackers: http://core.tcl.tk/tcllib/reportlist. and while you're there, please also drop any ideas for enhancements you may have for either the package and/or the documentation — we love a glow-up suggestion 💖

when you're proposing code changes, please provide unified diffs, i.e. the output of diff -u. that's the format, bestie, don't fight it 🎀

also note: attachments are strongly preferred over inlined patches. you can attach stuff by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. easy. slay 🦋

---

🌈 KEYWORDS 🌈

in-memory channel, reflected channel, tip 219, virtual channel

---

⭐ CATEGORY ⭐

Channels

---

💜 COPYRIGHT 💜

Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

okay that's the whole page, bestie, you ate that 🍓 this was tcllib, version 1.0.4, serving you tcl::chan::string(n) realness. go forth and make in-memory channels. no cap 💅✨