hashtable-clear!(3scm)

✨ NAME ✨

Okay so hashtable-clear! from the Scheme Programmer's Manual — page tag hashtable-clear!(3scm) — is here to remove all entries from a hashtables ✨ (yes, the original says “a hashtables,” and we are keeping that exact line, periodt 💅).

📚 LIBRARY 📚

These are the imports, bestie — both tagged ;R6RS:

(import (rnrs))                     ;R6RS
(import (rnrs hashtables))          ;R6RS

🪄 SYNOPSIS 🪄

(hashtable-clear! hashtable)
(hashtable-clear! hashtable k)

💖 DESCRIPTION 💖

It removes all associations from hashtable. Like, every single one. Gone. Slay. 💅

If you give it a second argument, the current capacity of the hashtable is reset to approximately k elements. That's the whole tea, fr fr.

🎀 RETURN VALUES 🎀

This procedure returns unspecified values. No promised useful return value, bestie — it's giving side-effect main character energy. ✨

🌸 EXAMPLES 🌸

Vibe check: make an eq hashtable, set foo to bar, clear the whole thing, then check the size — and boom, it's 0:

(let ((ht (make-eq-hashtable)))
  (hashtable-set! ht 'foo 'bar)
  (hashtable-clear! ht)
  (hashtable-size ht))
  => 0

🚨 ERRORS 🚨

This procedure can raise exceptions with the following condition types:

• &assertion (R6RS) — the wrong number of arguments was passed or an argument was outside its domain. In particular, hashtable should be a mutable hashtable and k should be an exact non-negative integer.

👀 SEE ALSO 👀

Go check out hashtable-delete!(3scm) — it's right there in the same orbit, bestie. 💖

📜 STANDARDS 📜

R6RS — that's the standard, periodt.

🕰️ HISTORY 🕰️

This procedure first appeared in R6RS. Iconic since day one. 👑

👑 AUTHORS 👑

This page is part of the scheme-manpages project. It includes materials from the RnRS documents. More information can be found at https://github.com/schemedoc/manpages/.

Cute sign-off: this page is from the Scheme Programmer's Manual, dated 2023-01-21, page tag hashtable-clear!(3scm) — bye bestie, go clear some tables 💖🫶✨