tcl::t...adler32(3tcl)

💖 tcl::transform::adler32 — Adler32 transformation 💖

okay bestie, welcome to the Reflected/virtual channel support corner of the manual, section 3tcl, and today's main character is tcl::transform::adler32. she's a transformation. she's a checksum girlie. let's get into it 🎀

---

✨ NAME ✨

tcl::transform::adler32 — Adler32 transformation

---

🌸 SYNOPSIS 🌸

package require Tcl 8.6 9

package require tcl::transform::core ?1.1?

package require tcl::transform::adler32 ?1.1?

::tcl::transform::adler32 chan -option value...

---

🦋 DESCRIPTION 🦋

so the tcl::transform::adler32 package hands you a command that builds a channel transformation. what does it do? it lets the read and written bytes pass through completely unchanged — literally like tcl::transform::identity, no edits, no filter, no drama — but additionally it continuously computes the adler32</> checksums of all the data it has seen, for each direction, and stashes them in Tcl variables that you name at construction time. it's giving "I'm just standing here looking pretty while also doing math in the background" 😌✨

its related transformations in this module are tcl::transform::counter, tcl::transform::crc32, tcl::transform::identity, and tcl::transform::observe — the whole friend group, fr fr 🫶

and the internal TclOO class that implements the transform handler? it's a subclass of the tcl::transform::core framework. iconic lineage 💅

---

👑 API 👑

• ::tcl::transform::adler32 chan -option value... — this command creates an adler32 checksumming transformation on top of the channel chan and returns its handle. the accepted options are:
  • -read-variable varname — the value of this option is the name of a global or namespaced variable, i.e. the spot where the transformation has to store the adler32 checksum of the data read from the channel.

if it's not specified, or it's the empty string, then the checksum of the read direction is not saved. no variable, no vibes. 🙈

• -write-variable varname — the value of this option is the name of a global or namespaced variable, i.e. the spot where the transformation has to store the adler32 checksum of the data written to the channel.

if it's not specified, or it's the empty string, then the checksum of the write direction is not saved. same deal. 💀

---

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. like, obviously. please report those in the category virtchannel of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. and please also send in any ideas for enhancements you may have for either the package and/or the documentation — we want the glow-up ideas, bestie 🌈

when you're proposing code changes, please provide unified diffs, i.e. the output of diff -u.

also note that 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. iykyk 🎀

---

⭐ KEYWORDS ⭐

adler32, channel transformation, checksum, reflected channel, tip 230, transformation, virtual channel

---

🧚 CATEGORY 🧚

Channels

---

💜 COPYRIGHT 💜

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

---

and that's the whole page, periodt 💅 this was tcllib, version 1.1, section 3tcl — thanks for reading, bestie, go checksum something and slay ✨🦋🌸