bench::in(n)

✨ bench::in(n) ✨

ok so bestie, welcome to bench::in 💖 it's a lil page from the Benchmarking/Performance tools corner of the manual (the n part means it's a Tcl package doc, iykyk), and honestly? it's giving "small but mighty" 🎀

---

🌸 NAME 🌸

bench::in — reading benchmark results. that's it, that's the whole job. no cap.

---

🦋 SYNOPSIS 🦋

package require Tcl 8.5 9

package require csv

package require bench::in ?0.2?

::bench::in::read file

look at that. so clean. ✨ ?0.2? means the version is optional, bestie, it's a lil "you can pin it if you want" situation 💅

---

💜 DESCRIPTION 💜

this package hands you one whole command for reading benchmark results out of files, sockets, etc. etc. — the whole "results can live anywhere" vibe 🌈

now if you're the kind of reader who's actually into creating, processing or writing these results instead of just reading them? bestie you're in the wrong doc, go read bench — Processing benchmark suites 🫶

and if it's the bench language itself that has you in a chokehold (valid), start with the bench language introduction and then proceed from there to the formal bench language specification. the pipeline is pipeline-ing 🔥

---

👑 PUBLIC API 👑

💖 ::bench::in::read file

this command reads a benchmark result from the specified file and returns it as its result. one file in, one result out. main character energy fr fr 👑

and here's the slay part: it understands three different formats — the exact 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 format the input file is using. no flags, no hints, no "pls tell me which one" — it just knows 🧚✨ iconic behaviour honestly

---

🎀 BUGS, IDEAS, FEEDBACK 🎀

ngl, this document AND the package it describes will undoubtedly contain bugs and other problems 😭 it's giving "we're all just doing our best out here". pls report them in the category bench of the Tcllib Trackers at:

http://core.tcl.tk/tcllib/reportlist

also pls send any ideas for enhancements you may have for either the package and/or the documentation. we want them, fr fr 💌

when proposing code changes, pls provide unified diffs, i.e. the output of diff -u.

and note further — this one's important bestie — attachments are strongly preferred over inlined patches 🙈 you can make an attachment 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. yes, that specific button. the left-most one. 💅

---

🌈 SEE ALSO 🌈

bench, bench::out::csv, bench::out::text, bench_intro

(the whole friend group, basically 🫶)

---

⭐ 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 the whole page, bestie 🎀 big love to tcllib, version 0.2, for bringing us bench::in(n) — go read some benchmark results, you deserve it 💖✨🦋