bench::in(3tcl)

💖 bench::in — reading benchmark results 💖

okay bestie, so this is bench::in, a manual page from the Tcllib docs (section 3tcl, the Tcl library pages, iykyk). it's literally the reader half of the benchmarking toolkit, and it's gonna be your new obsession. let's go 🦋

---

✨ NAME ✨

bench::in — reading benchmark results. that's the whole vibe. we read, we parse, we slay. 💅

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require csv

package require bench::in ?0.2?

::bench::in::read file

---

🎀 DESCRIPTION 🎀

so this package hands you one (1) command for reading benchmark results, and it's not picky about where those results are living — files, sockets, etc., it does not care. it will find them and read them. main character energy fr fr. ✨

now if you're actually interested in making, processing, or writing these results instead of reading them, then babes you're in the wrong lane — go read bench - Processing benchmark suites instead. that's the one for you. 💖

and if it's the bench language itself that has you in a chokehold? start with the bench language introduction and then keep going from there into the formal bench language specification. one step at a time, you got this. 🫶

---

👑 PUBLIC API 👑

::bench::in::read file

okay so this command reads a benchmark result from the file you point it at, and returns that result as its own result. that's it. that's the whole job. iconic. 💅

the way that it understands three formats, specifically the ones made by these commands:

• bench::out::raw — provided by package bench.
• bench::out::csv — provided by package bench::out::csv.
• bench::out::text — provided by package bench::out::text.

and it automatically detects which of those formats your input file is using. no flags, no config, no asking. it just knows. 🧚✨

---

😭 BUGS, IDEAS, FEEDBACK 😭

not to be dramatic but this document, and the package it describes, will undoubtedly contain bugs and other problems. it's giving "nothing is perfect and that includes docs". 🙈 please report them in the category bench of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. 💖

and please also send any ideas for enhancements you may have for either the package and/or the documentation. we want them. we love them. give us them. 🫶

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

also, note further that attachments are strongly preferred over inlined patches. to make an attachment, go to the Edit form of the ticket immediately after its creation, and then use the left-most button in the secondary navigation bar. periodt. 💅

---

🌈 SEE ALSO 🌈

• bench
• bench::out::csv
• bench::out::text
• bench_intro

---

⭐ KEYWORDS ⭐

benchmark, csv, formatting, human readable, parsing, performance, reading, testing, text 🌸

---

💜 CATEGORY 💜

Benchmark tools 🔥

---

🍓 COPYRIGHT 🍓

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

---

and that's a wrap bestie!! 🎀 this one came from tcllib, version 0.2, and yeah that's the whole page — go read some benchmarks, you absolute legend. mwah 💋✨🦋